SysOp's Arsenal

home *** CD-ROM | disk | FTP | other *** search

/ SysOp's Arsenal / SysOp's Arsenal 1 (Arsenal Computer).ISO / doorwre2 / mbpro160.exe / MBPRO.EXE / MBPRO.DOC < prev next >

Wrap

Text File | 1993-11-09 | 138KB | 3,031 lines

----------------------------------------------------------------------------- *** MODEM-BASE PRO Version 1.0 *** Finally, a Smart On-line DBMS! (c) 1993 by Integrated Solutions Inc. (ISI) All Rights Reserved. ----------------------------------------------------------------------------- INTRODUCTION ------------------------ Note : This is a limited online documentation included for the TEST DRIVE release of Modem Base Pro. A complete professionally printed manual is included with the commercial product. References else- where in the SETUP documentation that calls for page numbers, does not apply to this TEST DRIVE manual release. This was done in order to help keep the distribution size of the test drive program to a minimum. HOW TO USE THIS MANUAL... ------------------------- This documentation manual is intended to be used as a comprehensive installation and reference guide for MBPRO and is divided into 5 SECTIONS. Each SECTION is then broken down into seperate chapters. Each SECTION provides information about each of the MBPRO products. SECTION 1 discusses MBACCESS, the on-line door. SECTION 2 discusses MBMANAGE, the dBase utility. SECTION 3 covers COMPOSER, the setup and configuration program. SECTION 4 covers legal issues. SECTION 5 covers Technical Support. SECTION 1 - MBACCESS CHAPTERS : Chapters 1 - 2 will introduce you to the product and it's features. Chapter 3 teaches database basics and development theory. Chapter 4 discusses security issues and access. Chapter 5 discusses the features of the MBACCESS LINKAGE SYSTEM and the various LINK TYPES available. Chapter 6 offers a step-by-step tutorial and shows how to set up an on-line database or convert an existing one by providing specific instructions for each field in the CONTROL FILES. Chapter 7 provides information on various ADVANCED DATABASE DESIGN topics, such as networking databases, print processing, internal prompt configuration, and more. SECTION 2 - MBMANAGE CHAPTERS : Chapter 1 introduces MBMANAGE's features and capabilities. Chapter 2 discusses each command in detail. Chapter 3 teaches how to create new databases using MBMANAGE. SECTION 3 - COMPOSER CHAPTERS : COMPOSER is a seperate program that aids in the setup of your on-line database. Once a database is operational, this manual is also intended for use as a reference guide. It is strongly suggested that this manual be read in it's entirety due to many different features and capabilities available. A test database called MBPRO is included and used extensively during the tutorial and can also be run locally by typing MBPRO at the DOS PROMPT to see how MODEM-BASE Pro operates. SYSTEM REQUIREMENTS... ---------------------- MODEM-BASE Pro and MODEM-BASE Access are intended primarily for business applications, therefore no attempt has been made to support floppy only based systems. Below is a minimum requirement and by no means constitutes optimum suggestions for use. - IBM Personal Computer 8088 or 80X86 based CPU or compatible - PC-DOS or MS-DOS Version 3.3 or later. - Monochrome or Color Monitor (Mono/Hercules/CGA/EGA/VGA) - 384K free memory ( includes after shelling to DOS from a BBS ) - Hard Disk Drive recommended. - Modem ( except if used locally ) connected to a serial i/o UART port (IRQ 2-15 supported) or a Digiboard by Digi International (com8/8e/8i/16 models) or a standard Fossil interface. - A Bulletin Board System (BBS) that supports DOORS or the ability to transfer control to another DOS APPLICATION. - DOS SHARE.EXE loaded for multi-user (MODEM-BASE PRO) version. (or Novell Network) SHARE is a program that is provided with MS-DOS operating system. This file should be loaded prior to loading any of the MODEM-BASE Pro programs or a DOS SHARE compatible Network, such as Novell or Lantastic be in use. Although Windows claims to provide SHARE compatiblity, there is a known corruption bug that MicroSoft is aware of if SHARE.EXE is not loaded prior to Windows. We recommend using SHARE /F:4096 /L:40 in your AUTOEXEC.BAT file for best performance results. - MBMANAGE required ANSI.SYS driver to be loaded, i.e. DEVICE= C:\DOS\ANSI.SYS in your CONFIG.SYS file or if you are running under DesqView, use DVANSI. INSTALLATION ------------ Refer to your installation guide or INSTALL.DOC file. SECTION 1 : MODEM-BASE ACCESS (MBACCESS) ======================================== CHAPTER 1 - MODEM-BASE ACCESS (MBACCESS) FEATURES ------------------------------------------------- WHAT IS MODEM-BASE ACCESS (MBACCESS) ? -------------------------------------- MBACCESS is one of three programs and part of a powerful on-line DataBase Management System (DBMS). The complete system, comprised of all three MODEM-BASE PRO (MBPRO) programs is called "MODEM-BASE Pro DBMS". MBACCESS, specifically, is the program that allows your callers on-line access to standard dBase III structure compatible databases by providing an on-line "door" interface, accessible from your BBS (Bulletin Board System). MBACCESS is a professional BBS door application offering feature rich database access and customization, written specifically for the on-line BBS industry. Once MBACCESS is loaded it assumes full control over your caller. That means MBACCESS completely handles your callers connection, including, but definately not limited to, checking to make sure the caller does not lose carrier, maintaining the callers time limits as passed from the BBS, caller inactivity, sysop and caller chat, drop to dos capabilities while caller is on-line, informative caller status line, multi-node and multi-user sharing, and much more. WHAT/WHO IS MBACCESS FOR? ------------------------- MBACCESS is a versatile program than can be used for a wide variety of applications. MBACCESS is specifically written to be used for on-line BBS's (Bulletin Board System's), but can also be used in a "local" access mode and is additionally useful in network environments. The actual implementation of MBACCESS is unlimited. MBACCESS is intended for Database Management usage and compliments most dBase compatible products. Although, additional database management programs are not required to utilize MBACCESS to it's full potential, MBACCESS or MBMANAGE is not intended to replace these or other DBMS products, but work along with these products to offer an "on-line" addition to any database management tool library. ----------------------------------------------------------------------------- MBACCESS - FEATURE HIGHLIGHTS ----------------------------------------------------------------------------- - Full dBase III/Alpha IV/R:Base compatiblity and others - over 2 Billion record capability (MB PRO VERSION) - Full 128 field capacity (dBase III limitation) - Add/View/Edit/Search Records on-line. - On-Line RECORD BROWSE MODE. - Application Menu Configuration for multiple database selections - Review/Edit Feature before saving a new record to database. - Full Featured online Field Editing (INSERT/DEL/HOME/END/ARROWS) - Lines PER Screen configurable to match BBS settings - Supports ANSI color or MONO text output - Complete cache buffered data for speed - Full Error Trapping AND Reporting - Written & Optimized using Borland C++ 3.1 and Assembly - I/O Serial Routines Written & Optimized in Assembly OPTASM - Complete Multi-User Database Support!!! (NOVELL or DOS SHARE) - Memo File Support - up to 65535 characters per memo file - Memo Field Editor with Word Wrap - Relational configuration and database links - TABLE database field input processing - Unique Order Processing with Unique Number Generation - Multiple Choice Questions ( up to 2 Billion CHOICES! ) - Configurable Default User Profiles of commonly used data - Ability to display a help file for each field (MONO/COLOR) - Run Unlimited Databases (each Multi-User) from a single MBPRO - Configurable (ANSI) Welcome and Menu Screens - Allow file uploads to be attached to a database RECORD/JOB - Downloadable Customizable Reports of any record. - Print Processing of Customizable reports for invoicing/orders - File Transfer Protocols using DSZ Zmodem/Ymodem/Xmodem - Modular Design allows ease of use and expandability - TeleMagic(tm) Contact Management Software Link Compatibility - Supports Remote Extended Keyboard Commands - DOOR.SYS, CALLINFO.BBS, PCBOARD.SYS, CHAIN.TXT, DORINFOx.DEF - Any COMPORT, DIGIBOARD, and FOSSIL DRIVER support - Supports Wildcat (IM) Intelligent Multi-Port Software Version - SAFE RETURN to BBS if CARRIER LOSS occurs on-line - Field Level Security control per ACCESS TYPE. - FREE 90 DAY Technical Support - ...and much much more! ******************************************************************** * Type MBPRO at the DOS PROMPT to see a DEMONSTRATION of MBACCESS! * ******************************************************************** ----------------------------------------------------------------------------- MBACCESS IS COMPATIBLE... ------------------------- Although all the databases in MBPRO are indeed fully dBase III compatible, and can be viewed, edited, and queried using many popular dBase compatible products, such as Alpha IV, R:BASE, dBase III, and others, we have included a dBase utility called MBManage which is written exclusively for on-line use and MODEM-BASE. MBManage is a powerful multi-user database utility that is included with MBPRO to allow sysops a method in which to manipulate, add, and edit dBase III compatible databases with ease. SECTION 2 covers MBMANAGE. Because we chose to use dBase III compatible structure formats for MBACCESS, we were able to provide unique industry compatibility. Such compatibility will allow you to develop additional programs external to MODEM-BASE that can easily manipulate data. MODEM-BASE Access is simply the On-line Interface between your caller and your data and provides unlimited capabilities by maintaining dBase compatibility. The modular design of MODEM-BASE Access also provides complete control over data without hindering access to data from other products that are dBase compatible also. MBACCESS IS EXPANDABLE... ------------------------- Each Record that is generated using MBACCESS by a caller can be given a unique incremented JOB # which is read from the JOBNUM file and can be edited with any standard TEXT editor. (i.e.; if a beginning Job # value needs to be re-established, editing JOBNUM and placing a "0" as the first character in the text file, would result in the next record being generated as JOB #1.) This file could be used to write an additional monitoring program external to MBACCESS which would know when to process an order and possibly automate file handling of uploaded data. Since all files are dBase compatible, a large variety of programming development environments exist that can allow you to link your own applications to MODEM-BASE Pro. MBACCESS - THE WHOLE CONCEPT... ------------------------------- MBACCESS is more than an on-line questionairre, it is truly a "SMART" DBMS. MBACCESS is a useful Database Management Tool. Used in conjunction with a BBS, you can provide on-line intelligent access to your database. All these features combine to give MBACCESS a major role in the MODEM-BASE PRO (MBPRO) product line-up. CHAPTER 2 - MBACCESS DOOR INTERFACE ----------------------------------- WHAT IS A DOOR? --------------- A BBS "DOOR" has derived it's name because of the way it functions. Just like a real door that provides an opening from one place to another, BBS's often offer DOORS to access other programs from the main BBS. MBACCESS is such that it is called a "DOOR". Think of a BBS DOOR as simply a PORTAL or GATEWAY to another program application. Your BBS software must provide DOOR access in order to use MBACCESS. DOOR COMPATIBILITY ------------------ MBACCESS is DOOR.SYS compatible and also supports other BBS's as listed below or any BBS conforming to the DOOR.SYS format standards. MBACCESS reads information as provided by DOOR.SYS to allow the Sysop to configure databases which may utilize this information. Even BBS's that do not conform to one of these many types listed below, MBACCESS can use a GENERIC.SYS type and will ask specific information from the caller to generate a DOOR information file. Bottom line is that if your BBS program can shell to dos and run an external program, which many "dos based" BBS software packages can do this, then MBACCESS can work for you. At the same time, MBACCESS will exploit additional features available from certain BBS packages, such as Wildcat! and PCBoard automatically and activate these features should you fall into one of these categories. Throughout this documentation the word DOOR.SYS will be used to reference any of the below BBS TYPES unless otherwise specified. BBS TYPE DOOR FILENAME -------------------------------------------- Wildcat (2.x) - CALLINFO.BBS Wildcat (3.x) - DOOR.SYS GAP - DOOR.SYS VBBS (Virtual BBS) - DOOR.SYS SpitFire(3.x) - DOOR.SYS RBBS-PC - DORINFOx.DEF Quick BBS - DORINFOx.DEF RA (Remote Access) - DORINFOx.DEF PCBoard(12-14.x) - PCBOARD.SYS WWIV - CHAIN.TXT GENERIC - GENERIC.SYS and others supporting any above formats. --------------------------------------------- An example of each of the above DOOR files is provided along with MBPRO for testing purposes. See DORFILES.ZIP and CHAPTER 6 - DATABASE CONFIGURATION for more information. MBACCESS BEHIND THE SCENE... (the inner workings) ------------------------------------------------- MBACCESS is a state of the art door program. MBACCESS is fully capable of linking with most BBS programs by providing standard and configurable ComPort settings, Fossil, and/or Digiboard Driver Support. This provides tremendous support for a variety of different hardware platforms. Once MBACCESS loads it takes complete control over your caller. MBACCESS completely monitors modem carrier and will reliably cycle your caller if there is a disruption in connection and return gracefully to the BBS and properly close all database files in the process. With it's ability to provide both multi-user access to the door and the database files, MBACCESS is in a class all by its self! While the caller is in MBACCESS, several Sysop Features are available and can be displayed by typing ALT-H for HELP on the local door console. When the door is running you will notice a two line status display at the bottom of the local screen indicating the following information at a glance : |----------------------- Node # | |------------------- Com Port | | |------------- Caller Name | | | Time Started -------------------------| | | | Time Now -------------------| | | | | | | 1 (COM2) JOHN DOE 06:00 05:30 11/01/92 Sec=50 Alt-H = Help ORDER.DBF | | | | | |------------- Security | | |---------------------- Date | | Help Info ---| | dBase Filename -------------------| Pressing Alt-H will Toggle the status line display to view the following Function Key commands available and ALT key commands : ALT - N - Sysop Next to Use Door ALT - X - Exit to Dos after call logs off F3 - All Screen Output to Printer F4 - Sysop Page Toggle ON/OFF F5 - Drop to Dos while caller is on-line F7 - Alarm Toggle ON/OFF F8 - Force caller to logoff NOW F9 - Local Screen Output Toggle ON/OFF F10 - Chat with Caller Pressing Alt-H again will Toggle the status line display to view the ComPort configuration information. After a few seconds the status line will return to the first status line display format above. As you can clearly see, MBACCESS is a full featured door program packed with advanced but easy to use features that ensures your door operations to be as reliable as your BBS operations. MBACCESS will cycle a caller after x # of minutes of inactivity and signal the remote caller with a BEEP sound every x # of minutes to warn of inactivity. This important feature will prevent any remote sessions from becoming inactive and tying up the system for extended periods of time. (Times may be modified in configuration files.) MBACCESS provides you worry free on-line database processing for your dBase compatible files. CHAPTER 3 - DATABASE BASICS --------------------------- DATABASE DEVELOPMENT THEORY --------------------------- If you are already familiar with database development and theory, then you may want to skip this section, although it may be a good refresher for even the advanced database management user. Additionally, this tutorial builds upon concepts that are specific only to MBACCESS and is highly recommended. Whether you're using MBACCESS to allow access to a new database or an existing one, advanced planning is the key to any successful database. A "DATABASE" is nothing more than a collection of "DATA" about a particular "SUBJECT". For Example, an ADDRESS book is used to keep certain information about people, like phone number, address, and possibly birthdate or anniversary. If we wanted to put our address book in the computer, we would need to design a database to store the information about each person in our address book. The information on each person is called DATA and the person the information is about, is our SUBJECT. The example database included with MBPRO and used during the DATABASE CONFIGURATION in CHAPTER 6 and referenced throughout this manual has both a SUBJECT and DATA. The SUBJECT is YOU in our example MBPRO.DBF database. That's right. The MBPRO.DBF database is the same database which we use on-line to gather DATA (information) about a prospective MODEM-BASE Pro customer. Our MBPRO database represents a SUBJECT and contains DATA about that SUBJECT. The SUBJECT being customers and DATA being the information about the customers. Like a file cabinet where we would store FILE FOLDERS on each of our customers, a DATABASE is similar. Each RECORD in a database is similar in concept to that of a file folder. The contents within the RECORD contains DATA about our SUBJECT. An organized file folder might have a chart containing the name of the customer, address, and other information. The same applies for our database. Each RECORD in our database has a RECORD LAYOUT with the design of what information we want to keep about our customers. Just like our file cabinent that has many file folders, our database can have many records in it. The advantage the computer has over file folders in a file cabinent should be obvious. The computer can quickly manage records within a database, such as adding, deleting, searching, and browsing. While it is usually cumbersome to search for all occurences of the word "CONTRACTOR" in a file cabinent full of file folders, using a database on the computer can quickly search and retrieve each occurence. The added BONUS of using MBACCESS is that your "file cabinent" can be on-line and is the first database of it's kind to allow remote access to data in such an intuitive environment. When you decide to create a database, you need to organize your thoughts and figure out what your SUBJECT and DATA is and how they RELATE. You may want to collect or display DATA about a particular SUBJECT and you may even have different SUBJECTS that RELATE with one another. For instance, if you manufacture widgets you might be interested in setting up an on-line database in which people can call in and place an order for the various widgets you make. In this case, we have two different SUBJECTS: WIDGETS and CUSTOMERS. That means we need to create two different databases, one for WIDGETS and the other for CUSTOMERS. These two databases will hold DATA and gather information about our SUBJECTS. Let's continue onward with our WIDGET analogy. With both of our SUBJECTS now figured out, we need to go one step further and examine how the two SUBJECTS (WIDGETS and CUSTOMERS) relate to one another. Is the WIDGET database going to have data about our CUSTOMER? Of course not. The CUSTOMER DATABASE will have DATA about the customer and the WIDGET database will have DATA about our WIDGETS. They are seperate databases with seperate subjects and data. But what about our ORDERS? We will also need an ORDER DATABASE to add incoming orders to. Our ORDERS database needs to gather DATA from both our CUSTOMER and WIDGET databases and we begin to develop the relationship between each database. A common mistake often made by beginner database developers, is to try to combine more than one SUBJECT per database. This is an easy mistake to make, but can prove to be clumsy and usually doesn't offer any flexibility. For example, it wouldn't be very wise to include DATA fields about the cost price of each of our WIDGETS in our CUSTOMER RECORD LAYOUT. Each CUSTOMER may have an unlimited number of ORDERS. So, the moral of our story is that we need to keep our SUBJECTS as seperated as possible when designing our databases. That leaves us now with three SUBJECTS: 1) WIDGETS 2) CUSTOMERS 3) ORDERS Let's not get too overly concerned right away with the exact RECORD LAYOUT of each of these databases quite yet. Let's first think a little bit about how each of these databases RELATES to one another. Perhaps, you have heard the term "Relational Databases" before? What is the relationship between each of these databases is what we must figure out. To help us figure out how each database relates to one another, we should first analyze what our GOAL is. We need to get our CUSTOMERS ORDER of WIDGETS, right? Our ORDER database will need to get and store information from our CUSTOMER database telling us who is placing the order and how to bill it and ship it. Our ORDER database will also need to allow our CUSTOMER to CHOOSE from our WIDGET database and put that CHOICE in a field in our ORDER database. So... it looks like our ORDER database is our GOAL. That means our GOAL database is our MAIN database. Thus, the key to any database development is determining just exactly what the GOAL is and how each SUBJECT RELATES to one another to achieve that GOAL. We have done just that. So what do we have? Nothing yet, really. Just a concept, but the conceptual design of your database is by far the most important step towards making a successful database RECORD LAYOUT structure. Like an organized file cabinet, an organized and well-planned database makes it easier to manage. On the other hand, a messy file cabinet or a poorly planned database makes it difficult to manage and may be confusing to your callers or even the creator. Planning your database properly can save many hours of frustration later on. To summarize thus far, we now have figured out that our GOAL is our ORDER database. Our GOAL database is almost always our MAIN database. The other databases RELATE to our MAIN database. That means our ORDER database will REFER/RELATE to DATA found in these other databases to complete an order. This type of database setup is common and MBACCESS offers direct support to aid in the relation between each database. For instance, the customer database using MBACCESS can be defined as part of a DEFAULT USER PROFILE. Information in the user profile, such as the callers name, address, and phone number can be stored and retrieved with default information. That means every time the customer places an order, MBACCESS has the capability to LOOK UP the callers profile and if one exists pull the default information into the record. If MBACCESS doesn't find a DEFAULT USER PROFILE, then MBACCESS will ask the caller for the information contained in the user profile and store it for use during future sessions on-line. Information within the USER PROFILE is completely configurable within your MAIN DATABASE and you can even allow the caller to edit the information on-line or by going to his or her user profile from the main menu. This type of "SMART" processing is what gives you the power to make your on-line database come alive for your caller. You can run the MBPRO demonstration to see how it intuitively leads the caller through the database design during the information gathering process. These types of features should be kept in mind while designing your database for on-line usage so that you may exploit there power to your best interest. If each database is treated as a single SUBJECT and then we configure the database RECORD LAYOUT to hold DATA about that SUBJECT, we can use our databases to effectively RELATE with one another. Once the RECORD LAYOUT of the MAIN DATABASE going on-line is constructed, MBACCESS can then be instructed how to PROCCESS your database using CONTROL, LINKAGE, CHOICE, and PROFILE databases that RELATE to the MAIN DATABASE. Without getting ahead of ourselves, we can even have multiple GOALS or MAIN databases RELATE with each other in more advanced applications that can also be put on-line. For instance, our WIDGET parts database may also be put on-line so that our employees can call in from remote locations and update the parts database. When the customer calls in and uses the ORDER database on-line, any parts that have been updated will also be available to the customer. This type of RELATIONAL control offers unlimited design and implementation to you as the database developer. These basic database development concepts will be expanded upon in the following chapters as you learn about each of the different CONTROL, LINKAGE, CHOICE, and USER PROFILE databases. We will use these methods to show how our example MBPRO database follows under the same guidelines as above. Section II, Chapter 3 discusses database design using MBMANAGE. CHAPTER 4 - SECURITY AND ACCESS ------------------------------- INTERFACING THE CALLER TO YOUR DATABASE... ------------------------------------------ MBACCESS is the on-line interface to your database. In this Chapter you will learn about the different MODES OF OPERATION and SECURITY ACCESS to your database. These Concepts are important before moving on to the next chapters, "MBACCESS LINKAGE SYSTEM" and "DATABASE CONFIGURATION". MBACCESS MODES AND TYPES OF OPERATION... ---------------------------------------- What is a "Mode of Operation"? MBACCESS has the ability to offer different types of access to your database from callers based on security levels passed from your BBS. You can configure how they ADD, EDIT, VIEW or SEARCH information contained in your on-line database. MBACCESS has several MODES and TYPES of OPERATION each with different capabilities. The power behind MBACCESS is in it's inherent ability to perform isolated and secured tasks on dBase III compatible files. Let's look at each mode and type of operation and see what that means: "*" = Default Modes of Operation. ----------------------------------------------------------------------------- ADD TYPE MODES ----------------------------------------------------------------------------- 0) NO ADD ACCESS MODE This mode does not allow the caller to add any records to the database, but may browse or edit records in the database, if View or Edit Access is set below. This mode is useful if you have a .DBF file that you only want callers to be able to view, such as an information database, but not add any additional info to it. *1) FULL ACCESS ADD MODE This mode allows any caller to add records to the existing database as many times as needed. 2) OWNER ACCESS ADD MODE This mode only allows a SINGLE record to be accessed for each caller using the door. There is a check the first time the caller uses MBACCESS and if a record has not yet been added to the database under the callers name, then the caller is allowed to ADD a single record. That record is linked to the callers name which is passed from the BBS via the DOOR.SYS file and further usage of the database will only allow editing of that callers record if editing access has been enabled. A field with a NAME type must be defined and the OWNFIELD in the configuration database must contain this field #. This is how MBACCESS knows which field contains the name of the caller as passed from the BBS door file. See Chapter 6 for more details. ----------------------------------------------------------------------------- EDIT TYPE MODES ----------------------------------------------------------------------------- 0) NO EDIT ACCESS MODE This mode simply does not let caller edit any Records within the database. *1) FULL EDIT ACCESS MODE This is a very powerful mode and shouldn't be used in secure situations when you don't want your callers accessing other callers records! However if the need arises to allow callers of a particular database to do this, then this MODE will allow callers to access and EDIT ANY existing database record. The Security Level can be set so that only the SYSOP has this type of access. 2) OWNER EDIT ACCESS MODE This mode if enabled allows callers to EDIT their records in the database which they have ADDed to the database. A field with a NAME type must be defined and the OWNFIELD in the configuration database must contain this field #. This is how MBACCESS knows which field contains the name of the caller as passed from the BBS door file. See Chapter 6 for more details. ----------------------------------------------------------------------------- VIEW/SEARCH TYPE MODES ----------------------------------------------------------------------------- 0) NO VIEW ACCESS MODE No ability to view any records. *1) FULL VIEW ACCESS MODE Allows caller to search and view any record in the database. 2) OWNER VIEW ACCESS MODE Allows only owner of record to view his/her record(s). A field with a NAME type must be defined and the OWNFIELD in the configuration database must contain this field #. This is how MBACCESS knows which field contains the name of the caller as passed from the BBS door file. See Chapter 6 for more details. REVIEWING MODES AND TYPES OF OPERATION... ----------------------------------------- The varied usage of these modes is one feature out of many that makes MBACCESS very powerful. In review, there is simply three different TYPES and MODES of access. A caller can either [A]dd, [E]dit, and/or [V]iew/Search records within your on-line database. These are considered to be "TYPES" of access (Add/Edit/View). Each TYPE of access then also has an access MODE (Full,Owner,NO). FULL ACCESS MODE allows a caller to have full access for that TYPE of access, OWNER ACCESS MODE allows a caller to ONLY have access to his/her records for that TYPE of access, and NO ACCESS MODE DOES NOT allow the caller any access for that TYPE. For example, if you give a caller a FULL ACCESS MODE to an EDIT TYPE of access, then that caller could [E]dit ANY record within a database. This EDIT TYPE would also imply that the caller would have FULL ACCESS MODE for VIEW TYPES. You need to be able to [V]iew the record in order to edit it. Keep this in mind when creating or converting your on-line databases. BROWSING, VIEWING, SEARCHING, and EDITING DATABASES ONLINE ---------------------------------------------------------- Combining the power of ACCESS MODES and TYPES will allow your caller various access to BROWSE, VIEW, ADD or EDIT your on-line database. It is recommended that care be taken to assure that you only give your callers appropiate access to your database. For example, if you had a database that was simply a catalog of information, you may want to only allow your callers to Browse, View, and Download Information from your database. Be careful not to accidentally give your callers a specific security level for access to let's say EDITING. A caller would then be able to EDIT your database against your wishes. At any rate, MBACCESS contains a very powerful on-line database RECORD BROWSE/VIEW/SEARCH/EDIT feature. Callers can even ADD records from a BROWSE/VIEW/SEARCH mode. Additionally, the VIEW/EDIT feature is also used by MBACCESS if you have "REVIEW/EDIT" database enabled in your configuration. The latter allows your callers to review and/or edit a newly created record after adding it to the database to make sure everything is correct. ------------------------------------ [B]rowse Mode - VIEW/EDIT/SEARCH/ADD ------------------------------------ OVERVIEW -------- Using the [B]rowse feature of MODEM BASE PRO provides complete remote on-line database management. Each command is explained below in detail. You can use [ENTER] to toggle between BROWSE and RECORD VIEW/EDIT modes. MODEM BASE provides advanced searching features with it's SEARCH TABLE method. You can "telescope" SEARCHES up to 10 LEVELS deep to find the specific information you are looking for. Then depending on your security access you may download the information in your SEARCH TABLE in either dBase compatible format OR a REPORT format as customized by the System Operator. Helpful indicators exist to assist you in knowing how to navigate through the database. A green highlight bar displays the CURRENT RECORD# within the database if you are using ANSI graphics or the TOP RECORD if you have ANSI disabled. Below is a detail explanation of each command available. COMMAND SUMMARY --------------- Note: Not all commands may be available depending on security access as setup by the System Operator (SYSOP). Edit[#] ------- Allows you to select the RECORD# to VIEW if in BROWSE MODE or allow you to choose the FIELD# to EDIT if in VIEW/EDIT MODE. Complete on-line remote field editing commands are supported if your communication package supports extended keyboard codes or DOORWAY MODE, i.e.; Qmodem Pro by Mustang Software at 805-395-0223. Using extended keyboard codes while field editing allows you to use your left and right arrow keys to move throughout the field data, HOME will bring the cursor to the beginning of the input field, END will bring the cursor to the end of any data in the input field, ALT-D will DELETE the entire field, DELETE will delete the current character where the cursor is placed and move any characters to the right over to the left to fill in the deleted character, and of course [ENTER] accepts the data in the field as your input. Additionally, you may use the INSERT key to toggle insert mode if you wish to insert data into a field. [G]o ---- Will prompt for which FIELD# you want to go to and then move to that field# and make it the current field# for both BROWSE and VIEW/EDIT modes. The current field# (along with the current record#) is maintained globally even when working on several databases simultaneously in a [S]earch Table. [+] --- If in BROWSE MODE will allow you to scroll from right to left to the NEXT field number available. A red "+" indicator will appear to the right of the field names if more fields than can fit on the screen are available. If you are in VIEW/EDIT MODE then this also allows you to scroll to the next available field(s), but does it by displaying in PAGES of fields available within the current record. A "+MORE" indicator will appear if more fields than can fit on the screen are available. [-] --- If in BROWSE MODE will allow you to scroll from left to right to the PREVIOUS field number available. A red "-" indicator will appear to the left of the field names if more fields than can fit on the screen are available. If you are at the FIRST FIELD, then an indicator does not exist, but if you use this command you will wrap around to the LAST field in the RECORD. If you are in VIEW/EDIT MODE then this also allows you to scroll to previous available field(s), but does it by displaying in PAGES of fields available within the current record. A "-MORE" indicator will appear if more previous pages of fields than can fit on the screen are available. [N]ext ------ If in BROWSE MODE will display the [N]ext PAGE of records available in the database. A "[N]ext" indicator will appear if there are more records in the database than can fit on a single screen. If you are in VIEW/EDIT MODE then you will simply go to the [N]ext Record in the database. [P]rev ------ If in BROWSE MODE will display the [P]revious PAGE of records available in the database. A "[P]rev" indicator will appear if there are more records in the database than can fit on a single screen. If you are in VIEW/EDIT MODE then you will simply go to the [P]revious Record in the database. [D]el ----- Will mark the current record in either mode for deletion. A red astericks "*" will appear indicating that the record is marked for deletion. The record is not removed from the database, until the database is [C]leaned. The system operator can only [C]lean the database. (use MBMANAGE) [U]ndel ------- Will unmark the current record in either mode for deletion. The red astericks "*" will disappear in return the record to active use. [X]fer ------ Will allow you to download (transfer) data from the database or a [S]earch Table in either REPORT FORMAT as defined by the System Operator, or in .DBF format. Your current protocol as selected on the BBS will be used or you may [S]elect your protocol from the main menu. [A]dd ----- Will allow you to [A]dd a record to the database. This will utilize MODEM BASE ACCESS "smart" on-line processing as configured by the system operator for the database. You will not be allowed to [A]dd records to [S]earch Tables. [H]elp ------ Displays this file. [S]earch -------- Will allow a [S]earch by field # or ALL fields for a TEXT match. Two SEARCH options are available. You can either [G]o to the found RECORD/FIELD # or may create a SEARCH [T]ABLE. If [G]o is used, once a SEARCH is found Modem Base will REMAIN in <S>EARCH MODE. The record and field # found will become the current field and record # and any other action can be taken on the record or you may press "S" to continue [S]earching the database or [Q]uit your Search. If you use [T]able Search, then you will be able to create a seperate temporary database of the FOUND records. You can then [R]everse of [F]orward between each SEARCH TABLE created, up to 10 levels. You can then use [X]fer to Transfer (download) a report of the records found in your search or a .DBF file. [J]ump ------ Will [J]ump to the record number inputted. [E]dit ------ Will allow a FULL EDIT and ERASE of the current record. A warning is displayed before allowing the record to be erased. [L]ines ------- Will allow you to change the number of lines displayed per screen. [I]nfo ------ Will display field Information such as Field Type, Length, and Numeric Decimal Places. Types are listed below: C - Character D - Date N - Numeric L - Logical M - Memo [B]rowse or [ENTER] ------------------- Toggles between RECORD VIEW/EDIT and BROWSE modes. [Q]uit ------ Will [Q]uit back to MODEM BASE MAIN MENU or if in Search Mode, will [Q]uit the current search. -------------- Browse Summary -------------- Browse Mode, as you can see, is a sophisticated on-line mechanism for managing your databases. The above features are accessible per the configuration database access parameters. While in [B]rowse mode, several indicators and a straight forward command line input prompt provides the caller with the necessary information to navigate the system. At any one time in either the BROWSE or RECORD VIEW/EDIT mode, a CURRENT field and record # is always maintained, even through a toggle back and forth between modes. Additionally, MBMANAGE operates similar to MBACCESS BROWSE mode, but allows for a few additional features, such as database clean and the ability to create new databases. See Section II for details on MBMANAGE. CHAPTER 5 - LINKING MBACCESS TO YOUR DATABASE --------------------------------------------- MBACCESS LINKAGE SYSTEM... -------------------------- MBACCESS derives the majority of it's configurability through the use of a LINKAGE SYSTEM. What exactly does this mean? Well, without the MBACCESS LINKAGE SYSTEM, processing an on-line database wouldn't do very much. MBACCESS would have NO way of knowing what to do as it gathered information from your caller for each field in your database. However, with the MBACCESS LINKAGE SYSTEM, your fields within your database can be processed intelligently by giving MBACCESS specific instructions for EACH FIELD in your database about how to process that field. MBACCESS receives these instructions in the form of what is called LINK TYPES. Using LINK TYPES specific to MBACCESS within a seperate LINK DATABASE (which is also a dBase III compatible file), each RECORD can provide a set of instructions to MBACCESS to tell it how to process each field in the MAIN DATABASE. Each RECORD # in the LINK DATABASE corresponds to a FIELD # in the MAIN DATABASE, i.e.; RECORD #1 in the LINK DATABASE contains the LINKAGE information for FIELD #1 in the MAIN DATABASE, RECORD #2 corresponds to FIELD #2, and so on. View the structure format of MBPROL.DBF for an example link database file which corresponds with MBPRO.DBF main database fields. *** WARNING *** ---------------------------------------------------------------- The above concept is very important to understanding fully how MBACCESS works together with both the main database and the link database to perform specific tasks on-line. It is highly recommended that you are sure you understand this concept before moving on from this point. It will be covered in detail also in CHAPTER 6, "DATABASE CONFIGURATION". ---------------------------------------------------------------- LINK TYPES... ------------- Within the LINK DATABASE, LINK types provide instructions to MBACCESS on how to process each field in your database. These LINK types are described as follows: AUTO UPDATE LINKS ----------------- Auto Update Links are LINK TYPES which automatically retrieves certain information which is known about the caller, such as, Callers Name, Telephone Number, Order/Job#, Date, etc. and then places that information (also automatically) into the corresponding linked field and then allows MB Access to process the next field in the database. Example : If you defined an on-line sales order database, you may want to define a field called, "ORDER #". That field can then be defined as a JOB LINK TYPE in the corresponding LINKAGE DATABASE. When MB Access is processing the database for on-line input, it will realize that the field that was defined as "ORDER #" is of type JOB and will automatically place the next job number available from reading the file JOBNUM. (JOBNUM is a text file with the current job # of a database, refer to JOBNUM below) LINK TYPE DESCRIPTION ----------------------------------------------------------------- NAME - Puts name automatically into linked field as retrieved from DOOR.SYS file (or OTHER DOOR TYPES). FROM - Puts FROM INFORMATION automatically into linked field as retrieved from DOOR.SYS file. Note: Different BBS systems pass this information to DOOR.SYS differently. Wildcat! BBS passes the FROM information in the user database, NOT the CITY and STATE information. For information that is not passed to the DOOR.SYS file from the BBS, you can setup fields to be part of the USER PROFILE. See Chapter 6. PHONE1 - Retrieves Phone1 information automatically from DOOR.SYS file (or OTHER DOOR TYPES) and puts information into field for caller. PHONE2 - Same as PHONE1 above, but PHONE2 info. PID - Primary ID is derived from PHONE1 DOOR.SYS data, but only contains NUMERIC data. This is useful for indexing phone numbers and complies with Telemagic(tm) database PID field format. SID - Secondary ID will convert the callers name as passed to MBACCESS via the door information file in the form of LASTFIRST with no spaces. This, like PID above, is useful for indexing names and complies with Telemagic(tm) database SID field format. DATE - Puts current DOS date automatically into linked field. TIME - Puts current DOS time automatically into linked field. DTIME - Retrieves Current Date and Time in the format of [yy/mm/dd hh:mmx]. yy - year mm - month dd - date hh - hour mm - minutes x - a for am or p for pm Database field should be of [C]haracter type and should be 15 length or more. This field type was created to support TeleMagic(tm) dBase file formats for the RCL field "Recall Date-Time" format. JOB - Puts a unique incremented job number automatically into corresponding linked field. MB Access reads the job number from JOBNUM or the file pathname as set in the configuration database for JOBNUMPATH. FORCE - Requires that the caller DOES NOT leave the input field blank, this will FORCE an input from the caller for the specified field. RELATIONAL DATABASE LINK TYPES ---------------------------------------------------------------- CHOICE - Provides a list of choices which are read from another database file as specified in the link configuration file defined under CHOICE DBF and allows caller to select from the list and then will place answer from list into linked database field. The CHOICE type may also be used in conjunction with both the REPEAT types below as well as BRANCH types. (See CHAPTER 6) TABLE - Advanced powerful CHOICE feature. MBACCESS will create a REFERENCE TABLE of any fields STARTING at the field declared as a TABLE TYPE until whatever FIELD as defined in the CHOICEFLD (Linkage Database) and will skip CHOICEIDX (Linkage Database) number of Fields during processing. Used in conjunction with a CHOICE database as defined in the CHOICEDBF field, MBACCESS will display the x number of TABLE fields with DEFAULT selections as defined in the user profile and DEFAULT SETTINGS. An example where this can be handy is if you had a database that has several fields which are grouped together and in the same database. MBACCESS will generate a cross-reference table on-line allowing the caller the ability to make permanent or temporary changes to the user profile for items that are part of the TABLE. Any database items that can be grouped together as a SUBJECT, can be used in a TABLE. For instance, you might want to group together a CALLERS BILLING ADDRESS information. This information would be defined in his or her DEFAULT USER PROFILE. There may be five seperated fields in the database that are used in the RECORD LAYOUT for this. These fields can be grouped easily by defining the first field in the group as the TABLE field. Then you also tell it the number of fields consecutively that are in the group (CHOICEFLD) and your all set. MBACCESS knows how to handle the rest. When the caller is being processed on-line MBACCESS will display a TABLE of the fields in your group. The caller can PRESS [ENTER] to accept the DEFAULT SETTINGS for each field in the group as it is defined in his or her USER PROFILE, or select any one of the fields in the group to CHANGE temporarily for just the immediate record being added to the database, or even permanently have the option to make the new selection recorded in the DEFAULT USER PROFILE. DEFAULT - Will RETRIEVE corresponding field from the DEFAULT USER PROFILE DATABASE defined as "DEFAULT SETTINGS" in the OWNER field as set in the CONFIGURATION DATABASE. The DEFAULT data retrieved will then be AUTOMATICALLY inputted and IS NOT CONFIGURABLE by the CALLER! Important Note! If you want to use DEFAULT USER PROFILE INFORMATION that the caller can configure, you need to use the REPEAT OPTIONS as outlined below. Using this DEFAULT link type can allow you to automatically insert specific information into a database field, i.e.; a Store Location Number. (See CHAPTER 6) DBF - (planned for version 2.0) (planned version 2.0) Will allow link to another database for processing. Enhanced Relational Database Processing. DEFAULT USER PROFILE REPEAT OPTIONS (See CHAPTER 6 also) -------------------------------------------------------- OPTIONAL - O Allows reference to a default USER PROFILE record in the SAVED INFORMATION DATABASE. OPTIONAL REPEAT is configured in the LINK DATABASE for each field and may be used in conjunction with ANY LINK types, including CHOICE types. As MBACCESS processes a record in your database for input by the caller and as it encounters a field defined as a OPTIONAL REPEAT type, MBACCESS will look up the callers DEFAULT USER PROFILE in the SAVED INFORMATION DATABASE. (Note: MBACCESS will ask the caller to configure his/her DEFAULT USER PROFILE upon the first time [A]dding a record to the database, prior to processing the database, and only if a REPEAT type has been configured.) MBACCESS will retrieve the DEFAULT information for the REPEAT field being processed at the time and since it is an "Optional" Repeat, the caller is displayed the DEFAULT information, but is also given the oppurtunity to either hit [ENTER] and accept the DEFAULT infor- mation or edit the DEFAULT information displayed in the INPUT FIELD. If the field is defined as a CHOICE type and a OPTIONAL REPEAT type, then the list of CHOICES will be displayed along with the DEFAULT CHOICE as configured in the DEFAULT USER PROFILE and the caller may either hit [ENTER] for the DEFAULT CHOICE or select one of the available CHOICES from the list. SAVED - S This REPEAT type is similar to OPTIONAL REPEAT type in most aspects, accept that it DOES NOT allow the caller to EDIT the REPEAT information retrieved from the DEFAULT USER PROFILE. SAVED REPEAT will simply automatically place the default information into the field being processed and move on to process the next field. DEFAULT - D This will override the callers default user profile setting and pull up the value if one exists contained in the "DEFAULT SETTINGS" record within the default user profile database. It is important to note that this is usually only needed in conjunction with CHOICE types, otherwise a DEFAULT TYPE should be used. When used with CHOICE TYPES it overrides the callers DEFAULT CHOICE with that as defined in the "DEFAULT SETTINGS" record. See DEFAULT TYPE for more information on the "DEFAULT SETTINGS" record and it's usage. DEFAULT LINK TYPES ---------------------------------------------------------------- The following formats are handled directly by your database configuration and are specific to dBase compatiblity (refer to MBMANAGE.DOC for further details) : C - Character Field N - Numeric field and Number of Decimal Places D - Date Field L - Logical - True or False / Yes of No M - Memo - Attached file (up to 64K text) These field type characteristics are automatically handled by MBACCESS during user input and internal to database format. Each of these DEFAULT TYPES also have a defined LENGTH. Memo fields are the exception. Memo fields are 10 characters in length and the MEMO Field itself only holds a record number of the actual memo contained in the corresponding XXXXXXXX.DBT memo file where "XXXXXXXX" is the name of the database file. Memos are variable length fields and can be UP TO 65,535 characters. ----------------------------------------------------------------- Note:The linkage database name corresponds to the database name, but has a filename addition of "L", i.e.; the main database MBPRO.DBF has a corresponding link file MBPROL.DBF and each RECORD # in the MBPROL.DBF link file corresponds to the FIELD # in the main MBPRO.DBF database. ----------------------------------------------------------------- CHAPTER 6 - DATABASE CONFIGURATION ---------------------------------- MBACCESS CONTROL FILES ---------------------- Chart of Database Files Used by MBACCESS ---------------------------------------- MBPRO is used as our EXAMPLE database. Refer to the MBPRO example database files for actual examples. Use MBMANAGE to view and/or edit the MBPRO example database files or other dBase compatible utility. The CONTROL FILE filenames are derived ALWAYS from the MAIN (GOAL) database. In our example database MBPRO.DBF is considered to be the MAIN (GOAL) database. From this filename several other databases are used to provide information to MBACCESS on how to process our MAIN DATABASE. These are called, CONTROL FILES. Your database would replace any references to MBPRO with the filename of your MAIN DATABASE file. It is required that all MAIN DATABASE filenames be 6 or less characters. The other two characters within the 8 character filename (without extension) limitation are used to reference the database files within a single database. MBPRO.DBF <----------------------> (Main Database) | |-----------------> MBPROC.DBF (Configuration Database) |-----------------> MBPROL.DBF (Link Field Information Database) | | | | | CHOICE.DBF (CHOICE Database) | (CHOICE is the filename as configured | in the CHOICE field in this link | database MBPROL.DBF) | |-----------------> MBPROS.DBF (Default User Profile Database) | |-----------------> MBPRO.1 (Field #1 Display Help File) |-----------------> MBPRO.2 (Field #2 Display Help File) |-----------------> MBPRO.3 (Field #3 Display Help File) | : : : |-----------------> MBPRO.128 (Field #128 Display Help File) | |-----------------> MBPROG.1 (Field #1 ANSI Display Help File) |-----------------> MBPROG.2 (Field #2 ANSI Display Help File) |-----------------> MBPROG.3 (Field #3 ANSI Display Help File) | : : : |-----------------> MBPROG.128 (Field #128 ANSI Display Help File) | | |-----------------> MBPROD.1 (Field #1 User Profile Help File) |-----------------> MBPROD.2 (Field #2 User Profile Help File) |-----------------> MBPROD.3 (Field #3 User Profile Help File) | : : : |-----------------> MBPROD.128 (Field #128 User Profile Help File) | |-----------------> MBPRODG.1 (Field #1 ANSI User Profile Help) |-----------------> MBPRODG.2 (Field #2 ANSI User Profile Help) |-----------------> MBPRODG.3 (Field #3 ANSI User Profile Help) | : : : |-----------------> MBPRODG.128 (Field #128 ANSI User Profile Help) Note : The CONTROL Database RECORD LAYOUTS are available as MBPROC.NEW, MBPROL.NEW and CHOICE.NEW. These files contain empty databases (no records) of each of their respective RECORD LAYOUTS. The files can be used when creating NEW databases and renamed to confer with the MAIN DATABASE filename. As you can see from the chart above, each On-line Database can consist of several database files (all of which are dBase III compatible) that interact with each other to provide information to MBACCESS on how to process your caller and allow interaction with your on-line database that is intuitive and easy-to-use with smart processing features. Each of these database files will be explained in detail shortly. Other Files used by MBACCESS: JOBNUM is used if no file pathname is given in the configuration file to generate a unique JOB # for each record added to a database. Refer to CONFIGURATION CONTROL FILE. DSZUP.BAT DSZ Zmodem Protocol Z is passed by DOOR.SYS DSYUP.BAT DSZ Ymodem/G Protocol Y is passed by DOOR.SYS DSXUP.BAT DSZ Xmodem Protocol X is passed by DOOR.SYS DSCUP.BAT DSZ Xmodem CRC Protocol C is passed by DOOR.SYS DSOUP.BAT DSZ Xmodem 1K Protocol O is passed by DOOR.SYS (If "S" is passed by DOOR.SYS, then MBACCESS will allow the caller to SELECT the protocol to use at the time of UPLOAD) (Note: MBACCESS passes two parameters to the above DSZ batch files. First being the PORT NUMBER as passed by DOOR.SYS or overridden by the settings in the configuration file. The second parameter contains the WORKPATH as set in the configuration file and tells DSZ where the incoming files will be uploaded to. %1 and %2 respectively.) MB.BAT Batch file used to load MBMANAGE. Type MB <filename>. JOB.BAT Batch file provided to view JOBNUM file MBPRO.BAT Batch file which will execute MBPRO example demonstration database in local mode. [WELCOME FILES] Welcome Menu Pathname as set in configuration database (MBPROWEL.BBS) under WELCPATH. (See MBPROC.DBF file and detailed (MBPROWEL.SCR) information below). The welcome menu is displayed to a caller prior to viewing the MBACCESS Main Menu. (Note: The .BBS file is the MONO Color Graphics filename and the .SCR file is the ANSI Color Graphics filename.) *SUBSTITUTE YOUR DATABASE NAME FOR THE EXAMPLE MBPRO NAME* [MENU FILES] MB ACCESS Main Menu Pathname as set in configuration (MBPROMEN.BBS) database. (See MBPROC.DBF file and detailed information (MBPROMEN.SCR) below). If this file doesn't exist, then a default menu will be displayed supporting MONO and COLOR. *SUBSTITUTE YOUR DATABASE NAME FOR THE EXAMPLE MBPRO NAME* [SMENU FILES] Default User Profile Saved Information Database MBPRODEF.BBS Instruction or Information menu displayed to caller MBPRODEF.SCR prior to configuring default database for the 1st time. (See MBPROC.DBF file and detailed information below.) *SUBSTITUTE YOUR DATABASE NAME FOR THE EXAMPLE MBPRO NAME* [JOBNUM FILE] File pathname of JOBNUM file to be used instead of MBPRO.JOB the default file JOBNUM as described above. If this file doesn't exist, MBACCESS will try to use JOBNUM. (See MBPROC.DBF file and detailed information below.) *SUBSTITUTE YOUR DATABASE NAME FOR THE EXAMPLE MBPRO NAME* ATTACH.BBS ATTACH.BBS or ATTACH.SCR will be displayed if available ATTACH.SCR to offer instructions to the caller about how the file attachment is being used and whether he/she wants to upload files before or after adding records to the database. SUCCESS.BBS This file is displayed upon the successful processing of any SUCCESS.SCR uploaded files attached to a newly created record if enabled. PROMPTS.DAT This is a text file containing all the internal prompts within MBACCESS and may be edited using any DOS TEXT editor or MBCOMPOSER. Be careful not to change any of the LINE POSITIONS of the prompts within the file. Refer to Chapter 7, Internal Prompt Customization for more details. Putting your database on-line ----------------------------- Once you have given serious thought to the design of your database and you have figured out what your MAIN DATABASE will be, you can begin to follow the steps necessary to configure the CONTROL FILES and RELATIONAL DATABASES. For information about creating your DATABASE RECORD LAYOUT, see MBMANAGE.DOC for complete information on dBase database creation. We will use our MBPRO example database again to further explain in detail each of the CONTROL databases and how they interact together to bring a database to life on-line. ------------------------- The MAIN DATABASE EXAMPLE ------------------------- Refer to MBPRO.DBF example. If you look at the MBPRO.DBF main database RECORD LAYOUT you will see exactly what DATA we want to gather about our customer. You can use MBMANAGE to view the contents of the MBPRO.DBF database or any other dBase compatible management program and we highly encourage you to do so and become familar with the layouts. During our example, we will use MBMANAGE. Refer to SECTION II on MBMANAGE for detailed information and instructions on use for that product. The first thing you will notice about our RECORD LAYOUT is that all of our information is specific to our customer. Our customer is the SUBJECT of this database and the RECORD LAYOUT is what DATA we want to gather on that SUBJECT. This is a standard dBase compatible database and doesn't really do much by itself. If you are converting an existing database from another dBase compatible application, then your data file should be in a similar layout for the DATA pertaining to that SUBJECT. At any rate, we need to now tell MBACCESS how to utilize our MAIN MBPRO DATABASE so we can put it on-line with "SMART" processing. We do this by providing CONTROL FILES that MBACCESS uses to receive instructions on how to process your database. These CONTROL FILES are also dBase compatible database files, but with RECORD LAYOUTS specific to MBACCESS. Each of the MBACCESS CONTROL FILES is explained below. ------------------------------ The CONFIGURATION CONTROL FILE ------------------------------ Refer to MBPROC.DBF example. First, we will discuss the layout of the MBPROC.DBF file. The "C" in the filename denotes that this is the configuration file for MBPRO.DBF The first thing MBACCESS does when it loads is open the configuration file you passed to it from the command line, i.e. MBACCESS MBPROC. This tells MBACCESS several things including what the name of your MAIN database is. Below is a description of each field # in the MBPROC.DBF file and what it configures. View the example MBPROC.DBF file included as an example. MBPROC.NEW is a blank configuration database with the require RECORD LAYOUT and is used to generate a new configuration file for a database. Field# Field Name Description of what each field configures. ------------------------------------------------------------------ 1 DBFNAME Name of the MAIN database file. In our example it contains MBPRO.DBF which is the name of our MAIN database and tells MBACCESS we will be working with this database. After MBACCESS reads this configuration file, it will read the LINK FILE and then OPEN this database for processing. May also contain the database name for a menu choice database containing several database names which may be selected from a menu. See Field #2 below. 2 DESCRIPT Short Description of the database SUBJECT. This description will be displayed on the TITLE bar when the caller is adding, editing, viewing, or searching record(s) on-line. If you put the keyword @LOADMENU here then the DBFNAME above is a CHOICE database name. MBACCESS will then look for a database in STANDARD CHOICE format (see CHOICE.NEW) and Field #1 (CHOICE) will contain the name of a MAIN DATABASE to be loaded. Field #2 (DESCRIPT) will contain the name of the CHOICE description to be displayed if a menu is not used. Field #3 is unused. To utilize a menu for your database choices, MBACCESS will look for a .SCR or .BBS file depending on graphics mode with the filename as that of the DBFNAME in field #1 above. Each database name from the CHOICE database must contain a configuration and link file. Advanced menu generation could allow multiple menu levels by using @LOADMENU in the CHOICEs configuration file, which would point to yet another database of menu choices. 3 OWNFIELD Tells MBACCESS which field in the MAIN database is the OWNER's name of that record, i.e. this is usually the name of the person as passed from the BBS. If you look at the MBPRO.DBF MAIN database you will see that FIELD #3 is the CONtact Person Name. Here we tell MBACCESS that the OWNFIELD is 3. Additionally, Field #3 in the MAIN DATABASE is defined using the LINKAGE SYSTEM CONTROL FILE below as a NAME type. That means MBACCESS will automatically retrieve the callers name from the BBS door information file and place it into field #3. Then if we place a 3 here in OWNFIELD, MBACCESS knows that field #3 will be used to determine "WHO" owns each record and is used in determining both security access to information and the default user profile. 4 COMPORT This is a COMPORT OVERRIDE field and ONLY needs to be used if you are using NON-STANDARD com ports or you are using a FOSSIL DRIVER or DIGIBOARD. If this field is LEFT BLANK then MBACCESS will read the comport from the DOOR.SYS file and use standard IRQ and ADDRESS settings for COM1-COM4. If you have non-standard comports, then you need to put your ADDRESS and IRQ in this field in the following format : (PORT:03E8:5) exactly as written within the parentheses. YOU MUST USE the word PORT along with a colon, then a 4 digit address, another colon, and then the IRQ. This allows MBACCESS to use virtually any NON-STANDARD COMPORT. If you have the DIGIBOARD or FOSSIL DRIVER setting enabled below you will simply put the port # in this field. 5 LOCALBEEP If this is set to Y the LOCAL computer will beep along with the REMOTE computer. If it is set to N then the remote computer will only beep. MBACCESS sends BEEP warnings to the caller if there is inactivity as set below, or if input exceeds a line length. 6 BEEPTIME This is the amount of time in minutes that MBACCESS will wait before sending a BEEP to the caller to warn of inactivity. 7 NOUSETIME This is the amount of time in minutes that MBACCESS will wait before automatically logging the caller off after x minutes of inactivity, i.e. if set to 5 and the above BEEPTIME is set to 1, then if the caller sits on-line with NO ACTIVITY a BEEP will sound every minute and then after 5 minutes of inactivity the caller will finally be logged off. 8 BBSTYPE Put the name of your BBS here. This field is currently only useful for Wildcat or PCboard BBS's. 9 DOORSYSPATH This is the complete path and filename of where your DOOR information file is located. MBACCESS automatically knows how to handle each of the following DOOR FILENAMES : DOOR.SYS CALLINFO.BBS DORINFOx.BBS CHAINT.TXT PCBOARD.SYS GENERIC.SYS (if BBS doesn't support above) For testing purposes we have included DORFILES.ZIP which contains an example of each of these door information files. 10 DIGIBOARD Set this field to Y if using a Digiboard otherwise leave blank or set to N. If you are using a Digiboard or Wildcat! (IM) BBS, then you also need to set the COMPORT field above to the DIGIBOARD port number for that node. (Each record in the configuration (MPROC.DBF) file corresponds to each node in multi-node usage, i.e., Record #1 is Node #1, Record #2 is Node #2, etc. ) 11 FOSSIL Set this field to Y if using a Fossil Driver otherwise leave blank or set to N. If you are using a Fossil Driver (X00 and BNU has been tested) then you also need to set the COMPORT field above to the FOSSIL DRIVER port number for that node. 12 UPLOAD Set this field to Y if you are going to use the UPLOAD feature of MBACCESS. This allows callers to attach uploads to records added to a database. The uploaded file is ZIPPED into a unique filename with the JOBNUM of the file and placed into the ATTACHPATH. (Refer to Chapter 7 on File Processing) NOTE: PKZIP.EXE must be in the path for MBACCESS to properly ZIP the file. If using UPLOADS YOU *MUST* define both the WORKPATH (13) and ATTACHPATH (14) below for MBACCESS to work properly. The caller may upload his or her files before or after adding record(s) to the database. One file MUST be uploaded for each record if this field is set to Y. 13 WORKPATH If you are going to utilize the UPLOAD feature of MBACCESS which gives the caller the capability of attaching an upload to a record, then this field contains the FULL path of where you want the uploads to go to during the upload process. (Note: Your DSZ must be registered for this feature to work.) *** WARNING *** All files will be deleted in this directory prior to allowing the upload. DO NOT USE a directory that may contain files in which you DO NOT WANT to be deleted. After the files are uploaded, they will be ZIPPED into a packet with the filename XXXXXXXX.ZIP which is the JOB NUMBER of the record. Additionally, for the DOS SHELL to DSZ to work, COMMAND.COM must be located where your COMSPEC environment variable points to. In most cases this isn't a problem, but is documented here to assist in case you recieve an MBPRO -1 error/Dos Error 2. If the caller uploads several files at once, using batch upload protocols, then the MBACCESS will list the files that the caller uploaded and add a record to the database, gathering the information from the caller, for each file uploaded. 14 ATTACHPATH This field works in conjunction with the WORKPATH field 13 above. After the upload is complete MBACCESS will ZIP the upload and rename the file to the current JOBNUM and then move the file to this FULL path. This is useful if you don't have a registered DSZ, after the upload (which would be in the current directory) MBACCESS can move it. 15 WELCPATH This is the filename of the Welcome menu to be displayed before showing the caller the MAIN MBACCESS menu. You can use this to tell your caller about your online database or other information. Notice in the MBPROC.DBF example configuration CONTROL FILE that this field is configured as MBPROWEL with no filename extension. MBPRO will automatically look for a .SCR ANSI GRAPHICS file first to display if the caller has ANSI enabled. If it doesn't find one or if ANSI is disabled, it will then look for a .BBS MONO display file. If you put a filename extension MBACCESS will override this feature and read that file instead. See MBPROWEL.SCR and MBPROWEL.BBS for an example. 16 MENUPATH Same as 15 above, except will display an alternate MENU screen to your caller if this file does not exist. A DEFAULT MENU built into MBACCESS will be displayed instead. See MBPROMEN.SCR and MBPROMEN.BBS for an example. 17 SMENUPATH Same as 15 above, except will display this file when the caller accesses the DEFAULT USER PROFILE SYSTEM for the very first time! See MBPRODEF.SCR and MBPRODEF.BBS for an example. Note: This file is only displayed to the caller ONCE upon the first time MBACCESS creates a default user profile and MBACCESS will only try to create a default user profile if a field has been defined as a REPEAT TYPE as explained in the LINKAGE SYSTEM below. 18 JOBNUMPATH This is the filename of the JOBNUM file used for generating unique JOB numbers for each record. If no filename is used here a default filename JOBNUM will be used. This is only used if a field is defined as a JOB TYPE as explained in the LINKAGE SYSTEM below. 19 PROCESS [Y]es or [N]o to allow PRINT PROCESSING. If set to Y, then MBACCESS will print the REPORT FORMAT as defined in the PROCESSRPT pathname in field #21 to the PROCESSOUT pathname as defined in field #20 below. See CHAPTER 7, "Advanced Database Design" on PRINTING for more details. 20 PROCESSOUT This is the full pathname of the file to send PRINTING REPORTS to for PRINT PROCESSING. Each file that is ATTACHED to a record can print a report as defined in field #21 below and will also indicate on the report whether the file was attached successfully or unsuccessfully. This provides additionally flexibility by allowing you to put PRN, LPT1, LPT2, ... etc. so that you can send REPORTS to your printer. A form feed is automatically generated between reports. 21 PROCESSRPT This is the full pathname of the file used to generate a REPORT FORMAT for PRINT PROCESSING a report for each file added to a database. The report format is a simple DOS TEXT file that may be edited with any DOS TEXT word processor. Fields are printed using @ CODES. @#003 indicates to MBACCESS that the contents of field #3 should go wherever this is placed in the text file. Regular text is printed verbatim. See CHAPTER 7, "Advanced Database Design" on PRINTING for more details. 22-27* PATHNAMES Not implemented at this time. 28 ADDMODE The number below indicates the MODE in use. 0) NO ADD ACCESS MODE This mode does not allow the caller to add any records to the database, but may browse or edit records in the database, if View or Edit Access is set below. This mode is useful if you have a .DBF file that you only want callers to be able to view, such as an information database, but not add any additional info to it. *1) FULL ACCESS ADD MODE This mode allows any caller to add records to the existing database as many times as needed. 2) OWNER ACCESS ADD MODE This mode only allows a SINGLE record to be accessed for each caller using the door. There is a check the first time the caller uses MBACCESS and if a record has not yet been added to the database under the callers name, then the caller is allowed to ADD a single record. That record is linked to the callers name which is passed from the BBS via the DOOR.SYS file and further usage of the database will only allow editing of that callers record if editing access has been enabled. A field with a NAME type must be defined and the OWNFIELD in the configuration database must contain this field #. This is how MBACCESS knows which field contains the name of the caller as passed from the BBS door file. See Chapter 6 for more details. 29 EDITMODE The number below indicates the mode in use. 0) NO EDIT ACCESS MODE This mode simply does not let caller edit any Records within the database. 1) FULL EDIT ACCESS MODE This is a very powerful mode and shouldn't be used in secure situations when you don't want your callers accessing other callers records! However if the need arises to allow callers of a particular database to do this, then this MODE will allow callers to access and EDIT ANY existing database record. The Security Level can be set so that only the SYSOP has this type of access. *2) OWNER EDIT ACCESS MODE This mode if enabled allows callers to EDIT their records in the database which they have ADDed to the database. A field with a NAME type must be defined and the OWNFIELD in the configuration database must contain this field #. This is how MBACCESS knows which field contains the name of the caller as passed from the BBS door file. See Chapter 6 for more details. 30 VIEWMODE The number below indicates the mode in use. 0) NO VIEW ACCESS MODE No ability to view any records. 1) FULL VIEW ACCESS MODE Allows caller to search and view any record in the database. *2) OWNER VIEW ACCESS MODE Allows only owner of record to view his/her record(s). A field with a NAME type must be defined and the OWNFIELD in the configuration database must contain this field #. This is how MBACCESS knows which field contains the name of the caller as passed from the BBS door file. See Chapter 6 for more details. "*" = Default Modes of Operation. 31 SYSLEVEL Contains the SECURITY LEVEL as passed from the DOOR.SYS file of the minimum security level allowed to access the database for SYSOP LEVEL access. Sysop Level Access will allow you to DELETE and UNDELETE records from the database. NOTE: When creating new databases use the empty MBPROC.NEW structure by copying it to your database, i.e., if your database was WIDGET.DBF then you would use COPY MBPROC.NEW WIDGETC.DBF. The same applies for the link file below. (See MBPROL) ------------------------------- The LINKAGE SYSTEM CONTROL FILE ------------------------------- Refer to MBPROL.DBF example. The Linkage System CONTROL file is the key to customizing MBACCESS for "smart" processing. CHAPTER 4 explains MBACCESS Linkage System Types and concepts. Below is a list of each field number in the linkage database. Notice the use of the "L" in addition to the MAIN database filename to indicate that this file is a LINKAGE DATABASE. See MBPROL.DBF for an example of the LINKAGE SYSTEM in action. Remember that each RECORD # in the LINKAGE DATABASE corresponds to the FIELD # in the MAIN database, i.e., Record #1 in MBPROL.DBF corresponds to Field #1 in MBPRO.DBF and tells MBACCESS how to process the field. Notice there are 23 records in our example MBPROL.DBF file and there are 23 fields in our MBPRO.DBF MAIN database; One Linkage Record for each field. Field# Field Name Description of what each field configures. ------------------------------------------------------------------ 1 FIELDNAME Contains the Field Name you want to display instead of the dBase 10 character limited fieldname. (Allows up to 20 characters with spaces) The description field is designed to offer a better description than that offered by dBase field names. dBase limits field names to 10 characters with no spaces and doesn't provide much of a description of what the field is. If this field is blank, however, MBACCESS will use the dBase field name instead and display it to the caller. 2 TYPE See also CHAPTER 4 for a detailed list of all TYPES available in the LINKAGE SYSTEM and their use. The full name of the TYPE goes in this field. See MBPROL.DBF for an example of how the TYPES are used. Using the various TYPES allowed gives MBACCESS specific instructions on how to process the corresponding field. LINK TYPE DESCRIPTION ----------------------------------------------------------------- NAME - Puts name automatically into linked field as retrieved from DOOR.SYS file (or OTHER DOOR TYPES). FROM - Puts FROM INFORMATION automatically into linked field as retrieved from DOOR.SYS file. Note: Different BBS systems pass this information to DOOR.SYS differently. Wildcat! BBS passes the FROM information in the user database, NOT the CITY and STATE information. For information that is not passed to the DOOR.SYS file from the BBS, you can setup fields to be part of the USER PROFILE. See Chapter 6. PHONE1 - Retrieves Phone1 information automatically from DOOR.SYS file (or OTHER DOOR TYPES) and puts information into field for caller. PHONE2 - Same as PHONE1 above, but PHONE2 info. PID - Primary ID is derived from PHONE1 DOOR.SYS data, but only contains NUMERIC data. This is useful for indexing phone numbers and complies with Telemagic(tm) database PID field format. SID - Secondary ID will convert the callers name as passed to MBACCESS via the door information file in the form of LASTFIRST with no spaces. This, like PID above, is useful for indexing names and complies with Telemagic(tm) database SID field format. DATE - Puts current DOS date automatically into linked field. TIME - Puts current DOS time automatically into linked field. DTIME - Retrieves Current Date and Time in the format of [yy/mm/dd hh:mmx]. yy - year mm - month dd - date hh - hour mm - minutes x - a for am or p for pm Database field should be of [C]haracter type and should be 15 length or more. This field type was created to support TeleMagic(tm) dBase file formats for the RCL field "Recall Date-Time" format. JOB - Puts a unique incremented job number automatically into corresponding linked field. MB Access reads the job number from JOBNUM or the file pathname as set in the configuration database for JOBNUMPATH. FORCE - Requires that the caller DOES NOT leave the input field blank, this will FORCE an input from the caller for the specified field. RELATIONAL DATABASE LINK TYPES ---------------------------------------------------------------- CHOICE - Provides a list of choices which are read from another database file as specified in the link configuration file defined under CHOICE DBF and allows caller to select from the list and then will place answer from list into linked database field. The CHOICE type may also be used in conjunction with both the REPEAT types below as well as BRANCH types. (See CHAPTER 6) TABLE - Advanced powerful CHOICE feature. MBACCESS will create a REFERENCE TABLE of any fields STARTING at the field declared as a TABLE TYPE until whatever FIELD as defined in the CHOICEFLD (Linkage Database) and will skip CHOICEIDX (Linkage Database) number of Fields during processing. Used in conjunction with a CHOICE database as defined in the CHOICEDBF field, MBACCESS will display the x number of TABLE fields with DEFAULT selections as defined in the user profile and DEFAULT SETTINGS. An example where this can be handy is if you had a database that has several fields which are grouped together and in the same database. MBACCESS will generate a cross-reference table on-line allowing the caller the ability to make permanent or temporary changes to the user profile for items that are part of the TABLE. Any database items that can be grouped together as a SUBJECT, can be used in a TABLE. For instance, you might want to group together a CALLERS BILLING ADDRESS information. This information would be defined in his or her DEFAULT USER PROFILE. There may be five seperated fields in the database that are used in the RECORD LAYOUT for this. These fields can be grouped easily by defining the first field in the group as the TABLE field. Then you also tell it the number of fields consecutively that are in the group (CHOICEFLD) and your all set. MBACCESS knows how to handle the rest. When the caller is being processed on-line MBACCESS will display a TABLE of the fields in your group. The caller can PRESS [ENTER] to accept the DEFAULT SETTINGS for each field in the group as it is defined in his or her USER PROFILE, or select any one of the fields in the group to CHANGE temporarily for just the immediate record being added to the database, or even permanently have the option to make the new selection recorded in the DEFAULT USER PROFILE. DEFAULT - Will RETRIEVE corresponding field from the DEFAULT USER PROFILE DATABASE defined as "DEFAULT SETTINGS" in the OWNER field as set in the CONFIGURATION DATABASE. The DEFAULT data retrieved will then be AUTOMATICALLY inputted and IS NOT CONFIGURABLE by the CALLER! Important Note! If you want to use DEFAULT USER PROFILE INFORMATION that the caller can configure, you need to use the REPEAT OPTIONS as outlined below. Using this DEFAULT link type can allow you to automatically insert specific information into a database field, i.e.; a Store Location Number. DBF - (planned for version 2.0) (planned version 2.0) Will allow link to another database for processing. Enhanced Relational Database Processing. DEFAULT LINK TYPES ---------------------------------------------------------------- The following formats are handled directly by your database configuration and are specific to dBase compatiblity (refer to MBMANAGE.DOC for further details) : C - Character Field N - Numeric field and Number of Decimal Places D - Date Field L - Logical - True or False / Yes of No M - Memo - Attached file (up to 64K text) These field type characteristics are automatically handled by MBACCESS during user input and internal to database format. Each of these DEFAULT TYPES also have a defined LENGTH. Memo fields are the exception. Memo fields are 10 characters in length and the MEMO Field itself only holds a record number of the actual memo contained in the corresponding XXXXXXXX.DBT memo file where "XXXXXXXX" is the name of the database file. Memos are variable length fields and can be UP TO 65,535 characters. ----------------------------------------------------------------- Note:The linkage database name corresponds to the database name, but has a filename addition of "L", i.e.; the main database MBPRO.DBF has a corresponding link file MBPROL.DBF and each RECORD # in the MBPROL.DBF link file corresponds to the FIELD # in the main MBPRO.DBF database. ----------------------------------------------------------------- 3 REPEAT See also CHAPTER 4 for a detail list of the REPEAT OPTIONS available for the LINKAGE SYSTEM. You can put a "S" for SAVED INFORMATION REPEAT, or an "O" for OPTIONAL INFORMATION REPEAT, or a "D" for DEFAULT REPEAT. (See "DEFAULT SETTINGS" for more info.) REPEAT OPTIONS may be used in conjunction with TYPES above, even CHOICES. Any field defined as a REPEAT OPTION will generate a DEFAULT USER PROFILE in the SAVED INFORMATION DATABASE. See MBPROS.DBF for an example of the SAVED INFORMATION DATABASE. This database is a duplicate of the MAIN DATABASE RECORD LAYOUT, but keeps DEFAULT USER PROFILE INFORMATION of any field with a REPEAT OPTION defined and saves the information for future sessions. This also helps maintain a customizable CUSTOMER database or other information which may be repetitive and is often needed as explained in CHAPTER 3 DATABASE BASICS. DEFAULT USER PROFILE REPEAT OPTIONS ----------------------------------- OPTIONAL - O Allows reference to a default USER PROFILE record in the SAVED INFORMATION DATABASE. OPTIONAL REPEAT is configured in the LINK DATABASE for each field and may be used in conjunction with ANY LINK types, including CHOICE types. As MBACCESS processes a record in your database for input by the caller and as it encounters a field defined as a OPTIONAL REPEAT type, MBACCESS will look up the callers DEFAULT USER PROFILE in the SAVED INFORMATION DATABASE. (Note: MBACCESS will ask the caller to configure his/her DEFAULT USER PROFILE upon the first time [A]dding a record to the database, prior to processing the database, and only if a REPEAT type has been configured.) MBACCESS will retrieve the DEFAULT information for the REPEAT field being processed at the time and since it is an "Optional" Repeat, the caller is displayed the DEFAULT information, but is also given the oppurtunity to either hit [ENTER] and accept the DEFAULT infor- mation or edit the DEFAULT information displayed in the INPUT FIELD. If the field is defined as a CHOICE type and a OPTIONAL REPEAT type, then the list of CHOICES will be displayed along with the DEFAULT CHOICE as configured in the DEFAULT USER PROFILE and the caller may either hit [ENTER] for the DEFAULT CHOICE or select one of the available CHOICES from the list. SAVED - S This REPEAT type is similar to OPTIONAL REPEAT type in most aspects, accept that it DOES NOT allow the caller to EDIT the REPEAT information retrieved from the DEFAULT USER PROFILE. SAVED REPEAT will simply automatically place the default information into the field being processed and move on to process the next field. DEFAULT - D This will override the callers default user profile setting and pull up the value if one exists contained in the "DEFAULT SETTINGS" record within the default user profile database. It is important to note that this is usually only needed in conjunction with CHOICE types, otherwise a DEFAULT TYPE should be used. When used with CHOICE TYPES it overrides the callers DEFAULT CHOICE with that as defined in the "DEFAULT SETTINGS" record. See DEFAULT TYPE for more information on the "DEFAULT SETTINGS" record and it's usage. 4 CHOICEDBF This is the filename of the seperate CHOICE database which is a seperate dBase compatible database containing the list of CHOICES available for input. Field 2 MUST CONTAIN the CHOICE type in order for MBACCESS to look for a CHOICE database. See MBPRO database MBPRO.RET for an example of the record layout of a STANDARD CHOICE DBF. Run MBPRO example to see how MBPRO handles CHOICES online. If you want to use a DATABASE that does NOT use the STANDARD CHOICE DATABASE RECORD LAYOUT, then see 5-6 below. This can be useful for using seperate databases as a "LOOKUP" for a CHOICE SELECTION. You may use a full file PATHNAME here also. 5 CHOICEFLD Will allow you to use ANY dBase compatible database with the CHOICE option. You will simply tell MBACCESS here, which field in the CHOICE database (as configured in field 4 CHOICEDBF above) contains the choice that will be searched for by the index field 6 below. The caller will enter a [B]rowse mode of the database with the CHOICEIDX (below) and the CHOICEFLDs to SEARCH, CHOOSE, and SELECT from. 6 CHOICEIDX Will allow you to use ANY dBase compatible database with the CHOICE option. This field will work in conjunction with 5 above and will tell MBACCESS which field to search by and then retrieve the CHOICEFLD above as the CHOICE. This will allow the use of other MAIN databases for choices, i.e., an ORDER ENTRY database which needs to look up a PART DATABASE. This field will contain the field # of the the part to search by (perhaps a Stock #) and will give the caller the ability to search or browse or enter the search criteria online and then field 5 above will contain the CHOICE (the PART DESCRIP- TION) and enter that CHOICE into the MAIN database field as the callers CHOICE. 7* BRANCH Contains FIELD # that will be executed after this field. If this field is blank then the NEXT field will be executed in numerical ascending order or until the last field is reached. 8* COLOR If ANSI GRAPHICS is enabled by the caller then you can override the default colors in MBACCESS for the DISPLAY LINE ON THE FIELD. 9* COLORINPUT If ANSI GRAPHICS is enabled by the caller then you can override the default colors in MBACCESS for the INPUT LINE FOR THE FIELD. 10 EVALUATION Planned for Version 2.0 - Will allow fields to be processed before or after input with evaluate commands. 11 SECLEVEL This is the minimum SECURITY LEVEL as passed from the DOOR file to access this field. If the field is BLANK, SECURITY LEVEL check for corresponding field is DISABLED. NOTE: When creating new databases use the empty MBPROL.NEW structure by copying it to your database, i.e., if your database was WIDGET.DBF then you would use COPY MBPROL.NEW WIDGETL.DBF. The same applies for the configuration file above. (See MBPROC) ------------------------------------------- CHOICE.DBF - THE CHOICE DATABASE SELECTIONS ------------------------------------------- Refer to MBPRO.PRO example. If you define a field using the LINKAGE SYSTEM CONTROL FILE as described above as a CHOICE TYPE, then you may use the STANDARD CHOICE RECORD LAYOUT database structure for your CHOICE SELECTIONS. You can run the MBPRO demonstration to see how MBACCESS displays CHOICES to the caller. The available CHOICES are defined in this seperate database and over 2 Billion choices maybe used, however if you plan on using more than 40 choices you should consider using a CHOICE DATABASE with the LOOKUP CHOICEFLD and CHOICEIDX options as described in the LINKAGE SYSTEM CONTROL FILE section. The reason for this is because using the STANDARD CHOICE RECORD LAYOUT, although easier to use, displays all the choices on the screen to the caller. MBACCESS will automatically put your CHOICES into two columns if over 14 CHOICEs are available, but anymore than 40-44 CHOICES, (these are actually records in the CHOICE database) MBACCESS will not be able to fit all your choices on the screen and will scroll off the screen. The RECORD LAYOUT of the STANDARD CHOICE database is simple. Below is the fields for each record and their descriptions. 1 CHOICE Here is where the actual CHOICE selection exists. There is one CHOICE per record. Refer to MBPRO.RET to see how we used the MBPRO demonstration and the STANDARD CHOICE RECORD LAYOUT as defined in MBPRO.RET and each CHOICE that is displayed to the caller is pulled from this field. If you want to offer the caller the additional capability to ENTER a CHOICE not found in the selection, i.e. OTHER, then use the keyword OTHER here, and place a prompt description in field 2 below. Your CHOICES maybe up to 30 characters in length in the default CHOICE RECORD LAYOUT. This may be modified, by creating your own CHOICE DATABASE LAYOUT with these same fields, however. Make sure that your main database field that the CHOICE SELECTED will placed into is atleast 30 characters to hold the CHOICE selection or the CHOICE WILL BE TRUNCATED and an error displayed to the caller. So a good rule of thumb when creating CHOICE TYPE fields in your MAIN DATABASE LAYOUT and using STANDARD CHOICE DATABASES is to make the 30 characters in length also to conform with the 30 character lengths in the CHOICE DATABASE as defined with this field. 2 DESCRIPTION This field is used if the above field 1 has the keyword OTHER. When MBACCESS sees that you are using an OTHER CHOICE, it will display this description to the caller as one of the list of CHOICES and if the caller selects a field defined with the OTHER keyword, then MBACCESS will also display the description again and prompt the caller to input his or her response to this CHOICE. See MBPRO demonstration of how this works on-line. The CHOICE description in the default CHOICE RECORD LAYOUT is 60 characters. The callers input will be limited to the field length as defined in the main database field where the CHOICE will be put into however, so the length here is not important as above in field 1. 3 BRANCH This is a very powerful feature and allows you to decide where MBACCESS will go depending on the callers CHOICE. If you place a NUMBER in this field MBACCESS will go to that field # if the caller selects that CHOICE. If your database is properly planned, MBACCESS can offer endless intelligent response to your callers selections with this feature. If you leave this field blank, MBACCESS will go to the next field for processing or as determined by the BRANCH field in the LINKAGE CONTROL FILE as described above. NOTE: If you are using any CHOICE types, you can also copy CHOICE.NEW to the CHOICE database filename as configured in Field 4 of the LINKAGE CONTROL FILE. Refer to MBPRO.RET for an example CHOICE DATABASE. --------------------------------------------------- The DEFAULT USER PROFILE SAVED INFORMATION DATABASE --------------------------------------------------- Refer to MBPROS.DBF example. This database is simply a DUPLICATE of your MAIN database RECORD LAYOUT, but is used to hold repetitive field information as a DEFAULT USER PROFILE. MBACCESS will search this database by the OWNER FIELD as configured in the CONFIGURATION CONTROL database (see MBPROC.DBF example for OWNFIELD usage) and will use this file for any field defined as a REPEAT OPTION or a DEFAULT TYPE. If DEFAULT TYPE is used in the LINKAGE CONTROL database then MBACCESS will look for an OWNFIELD of "DEFAULT SETTINGS" rather than the name of the caller as passed from the BBS. See MBPROS.DBF for an example. Using the DEFAULT USER PROFILE can be very advantageous if your caller will be adding records to your database more than once. The first time MBACCESS processes a caller it will see if a DEFAULT USER PROFILE exists in the SAVED INFORMATION DATABASE for that caller. If one does exist and there are fields in the MAIN DATABASE defined as either a REPEAT OPTION or DEFAULT TYPE, then MBACCESS will pull up the existing USER PROFILE. If one does not exist then MBACCESS will ask the caller to setup his/her DEFAULT USER PROFILE (the SMENUPATH (MBPRODEF.SCR or MBPRODEF.BBS) will be displayed prior to entering the DEFAULT USER PROFILE SETUP). If you use the DEFAULT USER PROFILE system, make sure your MAIN database contains a field with the callers name and it is suggested that you use NAME TYPE in the LINKAGE DATABASE for that field so that MBACCESS will always automatically pull the callers name from the DOOR INFORMATION file and will remain constant. Also be sure to configure the OWNFIELD in the CONFIGURATION CONTROL database (MBPROC.DBF) to indicate what the field number of the callers name is. MBACCESS will automatically handle the rest. Copy an empty version of your MAIN DATABASE to the "S" version so MBACCESS can use this database for the SAVED INFORMATION. (If you are using MBCOMPOSER, it will automatically do this for you.) The caller can reconfigure his/her USER PROFILE at any time from the main MBACCESS menu. The Default User Profile can be used for many applications. It can generate a Customer Record of information that is not available as passed from the BBS in the DOOR INFORMATION file, such as Billing Address. YOUR DATABASE IN REVIEW... -------------------------- We have come a long way. Hopefully, at this point you can see the advantages of using MBACESS to interact your caller on-line to your database. With no programming skills and little database management skills you can configure a detailed interface. You can get quite advanced also and have several MAIN databases all relate with each other and ALL be on-line also. The power is at your disposal. We hope you find MODEM-BASE as exciting to use as we did while developing it. We encourage you to dissect the example MBPRO database and explore how it works. Use this manual as a reference guide when setting up new databases or converting existing ones. Enjoy the power of "SMART" DataBase Management On-Line! CHAPTER 7 - ADVANCED DATABASE DESIGN ------------------------------------ Network Operation ----------------- MODEM-BASE Pro is fully capable of multi-node and mult-user access. Each Node is configured with the configuration database (i.e., MBPROC.DBF) and each record in the database corresponds to the node. For example, Node 1 is Record 1, Node 2 is Record 2, and so on... The main difference between each node is the DOORSYSPATH and should contain a full path and filename of the nodes door information file. The information in this file is generated by the BBS before loading MBACCESS and is specific to the caller on that node. Advanced Novell Netware installations, can MAP ROOT a drive letter to point to the specified node door information file, and you can have all nodes setup as NODE 1, i.e., the DOOR.SYS path is MAP ROOT to drive W:, so in the DOORSYSPATH field in the configuration file, you would put W:\DOOR.SYS. Using MAP ROOT each drive W: on each node actually points to a DIFFERENT DOOR.SYS file. This means only 1 record needs to be configured and all nodes can use it, and just makes things a little easier to manage on larger network BBS's. You can also use DOS SUBST to acheive similar results, or Lantastics REDIRection. File Processing --------------- File Processing is unique to MODEM-BASE Pro and is provided for Sysops wishing to set up a database that allows the caller to ATTACH a file per record added to the database. Similar in concept to the way someone ATTACHES a file to a message, your callers can ATTACH files to database records. We have included a small on-line database, called RESUME.DBF which demonstrates this concept. By typing RESUME at the DOS PROMPT you can see it in action and how MBACCESS handles file processing. MBACCESS allows your callers to even add multiple records to a database and BATCH UPLOAD files to be selected for attachment to the records. Your callers even have the choice to upload their files BEFORE or AFTER adding their records to the database. The file ATTACH.BBS or ATTACH.SCR will be displayed to the caller prior to asking whether they want to upload BEFORE or AFTER they add their records to the database. This file should explain to the caller what is taking place and options. If the caller decides to upload file(s) BEFORE adding any records to the database, MBACCESS allows this and will handle the FILE PROCESSING details after the upload has taken place. Let's for example, say that a caller to our resume database, was a student counseler at a local college. The counseler had 5 resumes to add to our on-line database for students she was working with. She chose to upload her 5 files first and then would enter the information for each record. ( 5 records for 5 files ) After uploading her files to MBACCESS, MBACCESS displays a list of files that have been uploaded. MBACCESS physically lists all the files found in the WORKPATH as defined in the configuration database. Since 5 files were uploaded, MBACCESS displays all 5 files numbered [1]-[5] and asks her which file she wants to ATTACH to this record. She chooses the first file, but could have selected any one of the 5. When she gets to the FILENAME field, MBACCESS knows to put the name of the selected file in this field automatically. She then finishes entering the information for the record, MBACCESS then PROCESSES the file by ZIPPING it (PKZIP must be in the PATH) to the current JOB NUMBER ####.ZIP and moving the file to the ATTACHPATH as defined in the configuration database. If PRINT PROCESSING is enabled in the configuration database, then MBACCESS will also print a report to either a file, printer or BOTH and even include copy of the REPORT in the file ZIP package in the form JOBNUM.ZIP. (See PRINT PROCESSING below in this CHAPTER) MBACCESS then will list the 5 files uploaded to the system and this time will display that the selected file was processed and will allow her to enter one of the other 4 files left on the list. She also has the option to [Q]uit adding records to the database if for some reason there is a need to abort the operation in mid-stream. Once all 5 files have been attached to RECORDS added to the database, then MBACCESS exits to the main menu and the FILE PROCESSING cycle is complete. If the caller decides to upload file(s) AFTER adding record(s) to the database, MBACCESS allows the caller to enter as many RECORDS as desired, (limited to ACCESS MODES and TYPES as defined in the control files) and manually supply the filenames to be attached to each record in the filename field (a filename field must always exist for FILE ATTACHMENT and PROCESSING to operate properly). Then, once the caller is finished adding record(s), he or she will be allowed to upload the files at that time. All files are uploaded to the WORKPATH directory as specified in the configuration database and MBACCESS will MATCH each file uploaded to the system with the FILENAME that was entered for each record. MBACCESS will process all files uploaded and if a file is uploaded that does not match any of the records, it is ZIPPED into the JOBNUM.SUP file in the ATTACHPATH directory, where JOBNUM is the Job Number of the first record in the batch. If record(s) have been entered that an upload match was not found, the caller will also be allowed to try the upload again for any file(s) still not matched and processed, or allowed to [Q]uit and abort the operation. MBACCESS will also handle any interruptions in service during FILE PROCESSING, by processing all files that did make it to the system within a batch, and if PRINT PROCESSING is enabled (See Below), then it will also indicate the success or failure of each record attachment. Print Processing ---------------- PRINT PROCESSING is a concept developed to allow Sysops the capability to print a report to either the printer, a file, or BOTH for each record added to the database. Print Processing automates report generation and is executed after each record added to a database, but only if PROCESS is enabled in the configuration database, (Refer to MBPROC.DBF or CHAPTER 6, "Database Configuration") The REPORT FORMAT is user definable using any DOS TEXT/ASCII EDITOR. The PROCESSRPT field #21 in the configuration database contains the pathname of the REPORT FORMAT to be used for PRINT PROCESSING. The PROCESSOUT field #20 in the configuration database contains the PATHNAME of the file to print the REPORTS to and will create a file if one does not exist or add (append) to an existing one if found. If you select PRN, LPT1, LPT2, etc in the PROCESSOUT field, MBACCESS will send the REPORT to the appropiate printer port. If you use the keyword BOTH, MBACCESS will send the report to BOTH the PATHNAME as defined in PROCESSOUT and LPT1 printer port. REPORT FORMATS are simple and easy. Text in your report file is printed verbatim to the REPORT FILE or PRINTER. Using @CODES, MBACCESS can retrieve data entered from the field # of the current record being added to the database and print this data in your report. Using @#XXX where "XXX" is a 3 digit field number, MBACCESS will put the corresponding field number data in place of the @CODE. Using @NAMEOF#XXX where "XXX" is a 3 digit field number, MBACCESS will put the corresponding field name description as defined in the LINKAGE CONTROL FILE, or if a field name description does not exist, MBACCESS will use the dBase field name. Below is a sample of what a REPORT TEXT FILE may look like. ------------------------------------------------------------------------ MODEM-BASE PRO REPORT EXAMPLE of PRINT PROCESSING Callers Name : @#001 Address : @#002 City/ST/ZIP : @#003, @#004 @#005 @NAMEOF#006 : @#006 File attached: @#007 Attachment STATUS ------------------------------------------------------------------------ A typical report would probably have more information in the layout, but this should give you an idea of how you can manipulate the @CODES to place database field data where you want, allowing you to have complete customization of the REPORT LAYOUT and ease of modification with any TEXT/ASCII EDITOR. Take notice of the Attachment STATUS on our report format. MBACCESS will generate a SUCCESS or FAILURE file attachment message if FILE PROCESSING is in use. MBACCESS will also attach a copy of the REPORT to the ZIP file in the JOBNUM.ZIP format. If a record is added to the database and the file attachment was aborted a copy of the report will remain in the ATTACHPATH directory. ONLY successful file attachments will be in the JOBNUM.ZIP format. This allows for a complete audit trail of all events that a caller may make. Internal Prompt Customization ------------------------------------------------------------------------ MBACCESS was written with the end-user always in mind. The internal prompts that are displayed to your caller are concise and give you and your callers the appropiate information needed to guide through the system. In addition to being able to configure all screens, menus, and display files, you can also configure every internal prompt easily. The file PROMPTS.DAT contains all internal prompts (with the exception of internal error codes) that your caller may see while using MBACCESS. This allows you to easily edit prompts using any DOS TEXT EDITOR or MBCOMPOSER to your liking. SECTION 2 - MODEM-BASE MANAGE (MBMANAGE) ======================================== CHAPTER 1 - MODEM-BASE MANAGE (MBMANAGE) FEATURES ------------------------------------------------- MODEM-BASE Manage is a unique database utility with tremendous power & flexibility in a small and easy-to-use no-nonsense package with a "BBS" like user interface. MB Manage is fully dBase III compatible and can be used to create a new database or edit an existing one with powerful features usually only found in expensive database products costing hundreds of dollars or more. MB Manage is targeted for the On-line Industry and it's look and feel, although simple, is quite effective and useful on a variety of dBase management tasks. Our "Intelligent HOT-KEY Technology" (IHT) makes usage even more effective. MB manage offers fast and efficient searches and can edit, add, or view any standard dBase III files or even create new ones. With it's powerful enhanced Record [B]rowse Mode, databases can be easily and efficiently navigated and managed. MB Manage is provided as a useful tool for Sysops to manage dBase compatible .DBF files created and used by MBACCESS. (See Section I) MB Manage is NOT intended to replace database programming utilities, such as dBase III/IV, R:BASE, Alpha III/IV and many other dBase compatible programs that may also be used in conjunction with MODEM-BASE Pro DBMS, but should be considered a useful on-line addition to any dBase management library. MB Manage can be used solely however to create and maintain your on-line databases and utilize all available features. ----------------------------------------------------------------------------- MBMANAGE - FEATURE HIGHLIGHTS ----------------------------------------------------------------------------- - Full dBase III/Alpha IV/R:Base compatiblity and others - over 2 Billion record capability <registered version only> - Full 128 field capacity (dBase III limitation) - Create NEW dBase compatible files - Add Records to Databases - Robust Easy to Use Browse/Record View/Edit modes. - Edit Fields or entire Records easily - Delete and Undelete Records - Search Database with Enhanced Search Mode Features - Clean Database by purging all Deleted Records - Intelligent HOT-KEY Technology(tm) (IHT) - Numeric Decimal Input Technology(tm) (NDIT) - Lines PER Screen configurable. - Complete cache buffered data for speed - Full Error Trapping AND Reporting - View Field Sections of Data from record - Written and Optimized using C++ - Complete Multi-User Database Support!!! - Memo File Support - up to 65535 characters per memo file. - ANSI Graphics Support (Requires ANSI.SYS) - Memo Field Editor with Word Wrap ------------ Quick START. ------------ Using MBManage is straight-forward and easy. All instructions are clearly indicated "on screen". In order to edit an existing database file, simply type : MB <filename> at the DOS PROMPT. The filename can be UP TO 8 characters in length and does not require a file extension to be inputted. Your database file you want to load should be in dBase III compatible format. If MBMANAGE doesn't find the file or no filename is passed on the command line, it will ask you if you want to create a file or ask for another filename. Once you load (or create) a dBase compatible file, each command is surrounded by brackets, i.e.; [N]ext, tells you that if you hit the "N" key, you will proceed to the next record or if in [B]rowse mode, to the [N]ext Screen of Records. While Viewing a database record, you can use the [+] and [-] keys to scroll through the fields if there are more fields in the record than can fit on the screen. You can also change the number of lines shown per screen using the [L]ine Limit feature. [S]earching for a record you need to find is also easy with our full featured Search Mode. You can [E]dit, [A]dd, [D]elete, [U]ndelete, and even [J]ump to another record or [+]/[-] through fields while in Search Mode and have the power to hit [S] to continue your search from where you left off and MOST OF ALL, you can always use [H]elp for on-line instructions of each command. If you want to create a NEW database, simply type MB <filename> at the command prompt, where "filename" is the name of the NEW database to create. You may also simply type MB and you will prompted to supply MB Manage with a filename from within the program. ---------------------------------------------------------- BROWSING, VIEWING, SEARCHING, and EDITING DATABASES ONLINE ---------------------------------------------------------- Combining the power of ACCESS MODES and TYPES above your caller can have various access to BROWSE, VIEW, ADD or EDIT your on-line database. It is recommended that care be taken to assure that you only give your callers appropiate access to your database. For example, if you had a database that was simply a catalog of information, you may want to only allow your callers to Browse, View, and Download Information from your database. Be careful not to accidentally give your callers a specific security level for access to let's say EDITING. A caller would then be able to EDIT your database against your wishes. At any rate, MBACCESS contains a very powerful on-line database RECORD BROWSE/VIEW/SEARCH/EDIT feature. Callers can even ADD records from a BROWSE/VIEW/SEARCH mode. Additionally, the VIEW/EDIT feature is also used by MBACCESS if you have "REVIEW/EDIT" database enabled in your configuration. The latter allows your callers to review and/or edit a newly created record after adding it to the database to make sure everything is correct. ------------------------------------ [B]rowse Mode - VIEW/EDIT/SEARCH/ADD ------------------------------------ OVERVIEW -------- Using the [B]rowse feature of MODEM BASE PRO provides complete remote on-line database management. Each command is explained below in detail. You can use [ENTER] to toggle between BROWSE and RECORD VIEW/EDIT modes. MODEM BASE provides advanced searching features with it's SEARCH TABLE method. You can "telescope" SEARCHES up to 10 LEVELS deep to find the specific information you are looking for. Then depending on your security access you may download the information in your SEARCH TABLE in either dBase compatible format OR a REPORT format as customized by the System Operator. Helpful indicators exist to assist you in knowing how to navigate through the database. A green highlight bar displays the CURRENT RECORD# within the database if you are using ANSI graphics or the TOP RECORD if you have ANSI disabled. Below is a detail explanation of each command available. COMMAND SUMMARY --------------- Note: Not all commands may be available depending on security access as setup by the System Operator (SYSOP). Edit[#] ------- Allows you to select the RECORD# to VIEW if in BROWSE MODE or allow you to choose the FIELD# to EDIT if in VIEW/EDIT MODE. Complete on-line remote field editing commands are supported if your communication package supports extended keyboard codes or DOORWAY MODE, i.e.; Qmodem Pro by Mustang Software at 805-395-0223. Using extended keyboard codes while field editing allows you to use your left and right arrow keys to move throughout the field data, HOME will bring the cursor to the beginning of the input field, END will bring the cursor to the end of any data in the input field, ALT-D will DELETE the entire field, DELETE will delete the current character where the cursor is placed and move any characters to the right over to the left to fill in the deleted character, and of course [ENTER] accepts the data in the field as your input. Additionally, you may use the INSERT key to toggle insert mode if you wish to insert data into a field. [G]o ---- Will prompt for which FIELD# you want to go to and then move to that field# and make it the current field# for both BROWSE and VIEW/EDIT modes. The current field# (along with the current record#) is maintained globally even when working on several databases simultaneously in a [S]earch Table. [+] --- If in BROWSE MODE will allow you to scroll from right to left to the NEXT field number available. A red "+" indicator will appear to the right of the field names if more fields than can fit on the screen are available. If you are in VIEW/EDIT MODE then this also allows you to scroll to the next available field(s), but does it by displaying in PAGES of fields available within the current record. A "+MORE" indicator will appear if more fields than can fit on the screen are available. [-] --- If in BROWSE MODE will allow you to scroll from left to right to the PREVIOUS field number available. A red "-" indicator will appear to the left of the field names if more fields than can fit on the screen are available. If you are at the FIRST FIELD, then an indicator does not exist, but if you use this command you will wrap around to the LAST field in the RECORD. If you are in VIEW/EDIT MODE then this also allows you to scroll to previous available field(s), but does it by displaying in PAGES of fields available within the current record. A "-MORE" indicator will appear if more previous pages of fields than can fit on the screen are available. [N]ext ------ If in BROWSE MODE will display the [N]ext PAGE of records available in the database. A "[N]ext" indicator will appear if there are more records in the database than can fit on a single screen. If you are in VIEW/EDIT MODE then you will simply go to the [N]ext Record in the database. [P]rev ------ If in BROWSE MODE will display the [P]revious PAGE of records available in the database. A "[P]rev" indicator will appear if there are more records in the database than can fit on a single screen. If you are in VIEW/EDIT MODE then you will simply go to the [P]revious Record in the database. [D]el ----- Will mark the current record in either mode for deletion. A red astericks "*" will appear indicating that the record is marked for deletion. The record is not removed from the database, until the database is [C]leaned. The system operator can only [C]lean the database. (use MBMANAGE) [U]ndel ------- Will unmark the current record in either mode for deletion. The red astericks "*" will disappear in return the record to active use. [X]fer ------ Will allow you to download (transfer) data from the database or a [S]earch Table in either REPORT FORMAT as defined by the System Operator, or in .DBF format. Your current protocol as selected on the BBS will be used or you may [S]elect your protocol from the main menu. [A]dd ----- Will allow you to [A]dd a record to the database. This will utilize MODEM BASE ACCESS "smart" on-line processing as configured by the system operator for the database. You will not be allowed to [A]dd records to [S]earch Tables. [H]elp ------ Displays this file. [S]earch -------- Will allow a [S]earch by field # or ALL fields for a TEXT match. Two SEARCH options are available. You can either [G]o to the found RECORD/FIELD # or may create a SEARCH [T]ABLE. If [G]o is used, once a SEARCH is found Modem Base will REMAIN in <S>EARCH MODE. The record and field # found will become the current field and record # and any other action can be taken on the record or you may press "S" to continue [S]earching the database or [Q]uit your Search. If you use [T]able Search, then you will be able to create a seperate temporary database of the FOUND records. You can then [R]everse of [F]orward between each SEARCH TABLE created, up to 10 levels. You can then use [X]fer to Transfer (download) a report of the records found in your search or a .DBF file. [J]ump ------ Will [J]ump to the record number inputted. [E]dit ------ Will allow a FULL EDIT and ERASE of the current record. A warning is displayed before allowing the record to be erased. [L]ines ------- Will allow you to change the number of lines displayed per screen. [C]lean ------- Will Clean and purge the database and attached MEMO database. Any records marked as deleted will be removed. [I]nfo ------ Will display field Information such as Field Type, Length, and Numeric Decimal Places. Types are listed below: C - Character D - Date N - Numeric L - Logical M - Memo [B]rowse or [ENTER] ------------------- Toggles between RECORD VIEW/EDIT and BROWSE modes. [Q]uit ------ Will [Q]uit back to MODEM BASE MAIN MENU or if in Search Mode, will [Q]uit the current search. -------------- Browse Summary -------------- Browse Mode, as you can see, is a sophisticated on-line mechanism for managing your databases. The above features are accessible per the configuration database access parameters. While in [B]rowse mode, several indicators and a straight forward command line input prompt provides the caller with the necessary information to navigate the system. At any one time in either the BROWSE or RECORD VIEW/EDIT mode, a CURRENT field and record # is always maintained, even through a toggle back and forth between modes. CHAPTER 3 - DATABASE DESIGN --------------------------- ------------------------- Choosing a dBase filename ------------------------- Before creating your database you need to decide on a name for your database. MS-DOS allows filenames upto 8 characters in length. The 3 character filename extension will be automatically created by MBMANAGE and will use a ".DBF" filename extension to indicate the type of file created. .DBF files are typically dBase III file formats. That means that MBMANAGE or any other dBase compatible utility should work with any .DBF file that is in dBase III format. The technical specifications of the files are not important, but the compatibility issue is an additional benefit. When deciding on your filename and if you plan on using your new database for on-line usage with MBACCESS it is recommended that your BASE FILENAME only be 7 characters in length. The additional 8th character is used by MBACCESS to indicate various CONTROL, LINKAGE, and CONFIGURATION files. See Section I, Chapter 6 for details. ----------------------- Creating a NEW database ----------------------- At the DOS COMMAND PROMPT simply type MBMANAGE <filename>, where "<filename>" is the BASE FILENAME of your new database. The extension ".DBF" will be automatically added upon file creation and need not be inputted. MBMANAGE will at this point look to see if the file is already in the current directory and if it is not found will ask if you want to create the filename you passed to it on the command line. If you choose [Y]es, then you will be asked how many fields you want to have in your database. You can choose up to 128 fields, which is a dBase III limitation. At this point you will need to tell MBMANAGE a few things about each field in your database. The following four field type options are available: Field Name - Must Be 10 Characters or less with no spaces. Field Type - Must Be one of the following field types: c = character Allows alphanumeric characters d = date Supports the following inputted date styles: (dd=day, mm=month, yy=year, yyyy=full year) - Gregor mm/dd/yy - Gregor Long mm/dd/yyyy - Julian yyyy/dddd - YMD yyyymmdd - DMY ddmmyy - German dd.mm.yy - German Long dd.mm.yyyy - Italian dd-mm-yy - Italian Long dd-mm-yyyy - French dd/mm/yy - French Long dd/mm/yyyy - British dd/mm/yy - British Long dd/mm/yyyy - ENSI yy.mm.dd - ENSIL yyyy.mm.dd All input is converted to YMD format internally and displayed as Gregor. l = logical Allowed Logical Input Values Y = Yes N = No T = True F = False m = memo record Stores the memo record number of up to 64K of text in a seperate .DBT file. The .DBT file will automatically be created and record creation is handled internally by MBMANAGE for memos. n = numeric Only numbers allowed to be inputted into field. Field Length - Length of field. A database of up to 128 fields has a maximum combined field length of 4000 characters per dBase specification formats. MBMANAGE will keep track of combined field length formats and display available characters as a database is created. At 3000 characters, MBMANAGE will also issue a warning. Keep this field limitation in mind when creating large databases. An individual field length can be up to 254 characters. dBase handles 255 characters internally, but MBMANAGE uses the 255th character to indicate the end of a string. Decimal Places - Only used if a field type of numeric is defined. MBMANAGE and MBACCESS use Numeric Decimal Technology NDT to intelligently manage decimal placement within a data field. For example, if you had a field that had a field length of 10 with 2 decimal places, MBMANAGE while entering data would automatically know when to display the decimal point if after 7 characters where entered and no decimal point had been typed in yet. Keep in mind that the numeric field length above includes the decimal point and decimal places. Thus our 10 digit field length could have up to 7 digits, a decimal point, and 2 decimal places. MBMANAGE will not let you create more decimal places than allowed by field length. Once you have defined the above options for each field in your database MBMANAGE will proceed to create the new database with the defined RECORD LAYOUT and then ask if you want to go to the work screen where you will be prompted to add atleast one record to the database. Once your record is created you can use any of the commands as described in this section Chapter 2 above. Read Section I Chapter 3 on Database Basics for information and theory on designing a new database. SECTION 3 - MODEM-BASE COMPOSER (MBCOMPOSER) ============================================ SECTION 4 - MBPRO LEGAL ISSUES ============================== TERMS AND CONDITIONS: (READ LICENSE.DOC FOR YOUR LICENSE AGREEMENT) MODEM-BASE Pro, MBPRO, MODEM-BASE Access, MBACCESS, MODEM-BASE Manage, MBMANAGE, MODEM-BASE Composer, MBCOMPOSER, are all trademarks of Integrated Solutions and are Copyrighted material and are covered by law from copyright infringement. TeleMagic is a trademark of Remote Control International. MODEM-BASE Pro and products categorized as "Members of the MODEM-BASE Pro Family" are released as "Commercial Software". MODEM-BASE Pro Test Drive is a "Demo" version of the Commercial release of MODEM-BASE Pro DBMS and ONLY MODEM-BASE Pro Test Drive may be distributed freely. If you own a Commercial Version of the MODEM-BASE Pro software, you are REQUIRED BY LAW to NOT distribute this software. To do so, is in direct violation of copyright law and may result in prosecution to the full extent of the law. Beta Test versions are to be used only by authorized Integrated Solutions MODEM-BASE Pro Beta Testers and will expire after 30 days of usage. Test Drive Versions may easily be upgraded to a full commercial release version via an auto update registration process. Consult with Integrated Solutions Inc. at (909)780-8860(voice) or (909)780-5672(v.32BBS) or (909)780-5175 (2400BBS) if you have any questions regarding your license agreement. This product is distributed and sold "as is" and without warranty, except for the media on which this program is distributed. Integrated Solutions Inc. will not be liable for any damages either direct or indirect from the use of any of the MODEM-BASE Pro Family of Products. Use of this product implies that you agree to these terms and conditions and that you also agree and abide by the terms and conditions as stated specifically in your license agreement as outlined in LICENSE.DOC file. Consult with your License Agreement LICENSE.DOC for further information specific to MODEM-BASE Pro family of products. SECTION 5 - TECHNICAL SUPPORT ============================= Integrated Solutions Inc. is Serious about Support. Integrated Solutions has a FULL TIME development team, sales and technical support staff, and a quality team of alpha and beta testers to assure that only quality software reaches final distribution. Our reputation for service and quality has earned us the title as a "Certified Mustang Software Integrator (CMSI)" by Mustang Software Inc. (MSI) (developers of Wildcat! BBS and Qmodem Pro products) The following technical support programs have been established to fully assist you in obtaining help should you experience any difficulties. Below is a list of what technical support programs are available and what is covered under our technical support policy. TECHNICAL SUPPORT POLICY OPTIONS: --------------------------------- ------------------------ FREE 90 DAY TECH SUPPORT ------------------------ - Only Registered Owners of MODEM-BASE Pro Family of Products may receive FREE 90 Day Technical Support. Your FREE 90 Days begins with your first call to any of our technical support access methods available, i.e. ECTECH BBS MODEM-BASE Tech Support Conference, Voice Phone Call, fax correspondence, and other methods of contact with Integrated Solutions Inc. ------------------------------------------------------- ANNUAL TECH SUPPORT VIA ECTECH BBS AND AUTO-UPDATE PLAN ------------------------------------------------------- - You may purchase an Auto-Update plan for $49.00 per year which entitles you to automatic maintenance upgrades mailed to you direct every time a new maintenance release is issued within that year. New releases may be classified as Maintenance Releases or Feature Upgrade Releases. Your $49.00 also gives you FREE Golden Membership to ECTECH BBS, home of MODEM-BASE Pro DBMS, and subscription to our Fax Facts EC Newsletter. Most important of all is that you get unlimited access to the MODEM-BASE Pro Tech Support Conferences on-line via ECTECH BBS. (This DOES NOT include VOICE PHONE SUPPORT, see below) ----------------------------------------------------------------- FULL VOICE SUPPORT, 24 HOUR ACCESS, 24 HOUR BUSINESS DAY RESPONSE ----------------------------------------------------------------- - In addition to our Auto-Update Plan, we also provide direct voice technical support after FREE 90 days for an additional $200.00 per year and this entitles you to voice support and guaranteed 24 Hour Business Day Response and in most cases your call will be handled immediately 24 Hours by a real person. (This plan is in "addition" to any other plans offered.) WHAT IS COVERED BY TECHNICAL SUPPORT? ------------------------------------- Integrated Solutions makes every effort to make sure any needed technical support is handled in a fast and efficient manner. We have a full time technical support, sales, and programming staff. We operate two 24 Hour Emergency Hotlines and one of the largest 24 Hour on-line Technical Support BBS's in the world. We are serious about support and our committment to support YOU is second to none. Integrated Solutions is committed to providing you with all the technical support you require to get on-line should a malfunction occur with MODEM-BASE Pro Software. Should you require assistance in setting up your on-line database, we encourage you to first make sure you have gone through the section thoroughly on "Configuring Your On-line Database" above. If you have a problem that you feel isn't covered in the documentation that is preventing you from getting setup properly, we are happy to assist. We will often refer to methods learned from setting up the example database in this documentation and apply those methods to your problem. Technical Support IS NOT and WILL NOT be used as a substitute for not reading the documentation. WHAT IS NOT COVERED BY TECHNICAL SUPPORT? ----------------------------------------- Occasionally, a customer may require additional assistance in setting up an on-line database above and beyond what is considered to be covered by technical support. These type of issues usually refer to individuals requesting assistance in conceptual database design and the actual "developing" of the on-line database. Although, this is not considered to be covered per the above technical support policies, Integrated Solutions does offer a Complete on-line Solution Division that may assist with customization of your on-line database. Call the sales office (voice) at 800-633-6636 for a consultation appointment. As Certified Mustang Software Integrators (CMSI), our reputation for providing Complete Turn-Key Info Systems can help! HOW TO CONTACT US: ------------------ We provide several different channels in which you may access support ranging from voice phone calls to electronic mail. Below is a complete list of all the possible ways you can reach us. INTEGRATED SOLUTIONS INC. 2995 Van Buren Blvd A-13-189 Riverside, CA 92503 SALES ONLY 800-633-6636 (VOICE) TECH SUPPORT 909-789-7361 (VOICE) 24 HOUR EMERGENCY 909-279-3052 (VOICE) FAX 909-780-9570 (FAX) ECTECH BBS PO BOX 9099 Riverside, CA 92503 v.32 9600-14.4K bps 909-780-5672 (BBS) 1200-2400bps (CSP) 909-780-5175 (BBS) 24 HOUR EMERGENCY 909-279-3053 (VOICE) NOTE: Use CONFERENCE #2 on ECTECH BBS for MODEM-BASE Support. COMPUSERVE ID: 71764,352 - Technical Support 70031,2552 - Sales or Information RIME ID : ECTECH INTELEC : ECTECH Route all technical support messages to JIM PIERCE Route all Sales or information messages to TROY GETTY We are serious about support! END. -----------------------------------------------------------------------------